ImageField.DataAlternateTextFormatString プロパティ

  • リファレンス

定義

名前空間:
System.Web.UI.WebControls
アセンブリ:
System.Web.dll

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

public:
 virtual property System::String ^ DataAlternateTextFormatString { System::String ^ get(); void set(System::String ^ value); };
public virtual string DataAlternateTextFormatString { get; set; }
member this.DataAlternateTextFormatString : string with get, set
Public Overridable Property DataAlternateTextFormatString As String

プロパティ値

String

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

例

次のコード例では、 プロパティを使用して、オブジェクト内の DataAlternateTextFormatString イメージの代替テキスト値にカスタム形式を適用する方法を ImageField 示します。


<%@ Page language="C#" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>ImageField Example</title>
</head>
<body>
    <form id="form1" runat="server">
        
      <h3>ImageField Example</h3>
                       
      <asp:gridview id="EmployeesGrid"
        autogeneratecolumns="false"
        datasourceid="EmployeeSource"  
        runat="server">
      
        <columns>

          <asp:imagefield dataimageurlfield="PhotoPath"
            dataalternatetextfield="LastName"
            dataalternatetextformatstring="Photo: {0}" 
            nulldisplaytext="No image on file."
            headertext="Photo"  
            readonly="true"/>
          <asp:boundfield datafield="FirstName"
            headertext="First Name"/>
          <asp:boundfield datafield="LastName"
            headertext="Last Name"/>
        
        </columns>
        
      </asp:gridview>
          
      <!-- This example uses Microsoft SQL Server and connects  -->
      <!-- to the Northwind sample database. Use an ASP.NET     -->
      <!-- expression to retrieve the connection string value   -->
      <!-- from the Web.config file.                            -->
      <asp:sqldatasource id="EmployeeSource"
        selectcommand="Select [EmployeeID], [LastName], [FirstName], [PhotoPath] From [Employees]"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>" 
        runat="server"/>
            
    </form>
  </body>
</html>


<%@ Page language="VB" %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>ImageField Example</title>
</head>
<body>
    <form id="form1" runat="server">
        
      <h3>ImageField Example</h3>
                       
      <asp:gridview id="EmployeesGrid"
        autogeneratecolumns="false"
        datasourceid="EmployeeSource"  
        runat="server">
      
        <columns>

          <asp:imagefield dataimageurlfield="PhotoPath"
            dataalternatetextfield="LastName"
            dataalternatetextformatstring="Photo: {0}" 
            nulldisplaytext="No image on file."
            headertext="Photo"  
            readonly="true"/>
          <asp:boundfield datafield="FirstName"
            headertext="First Name"/>
          <asp:boundfield datafield="LastName"
            headertext="Last Name"/>
        
        </columns>
        
      </asp:gridview>
          
      <!-- This example uses Microsoft SQL Server and connects  -->
      <!-- to the Northwind sample database. Use an ASP.NET     -->
      <!-- expression to retrieve the connection string value   -->
      <!-- from the Web.config file.                            -->
      <asp:sqldatasource id="EmployeeSource"
        selectcommand="Select [EmployeeID], [LastName], [FirstName], [PhotoPath] From [Employees]"
        connectionstring="<%$ ConnectionStrings:NorthWindConnectionString%>" 
        runat="server"/>
            
    </form>
  </body>
</html>

注釈

オブジェクトに DataAlternateTextFormatString 表示されるイメージの代替テキスト値のカスタム形式を指定するには、 プロパティを ImageField 使用します。

注意

書式指定文字列は、 プロパティが DataAlternateTextField 設定されている場合にのみ適用されます。 プロパティが設定されている場合 AlternateText は適用されません。

これは、フィールドに含まれる元の値を変更する必要がある場合に便利です。 プロパティが DataAlternateTextFormatString 設定されていない場合、代替テキスト値は特別な書式を取得しません。

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

注意

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

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

注意

このパラメーターは、書式設定構文の一部です。 各セルにはフィールド値が 1 つしかないため、この値は 0 にのみ設定できます。

コロンとコロンの後の値は省略可能です。 コロン (B 一般的な例では) の後の文字は、値を表示する形式を指定します。 次の表に、一般的な形式を示します。

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

注意

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

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

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

適用対象

こちらもご覧ください