ImageField.DataAlternateTextFormatString プロパティ

定義

ImageField オブジェクトの各イメージの代替テキストの表示書式を指定する文字列を取得または設定します。Gets or sets the string that specifies the format in which the alternate text for each image in an ImageField object is rendered.

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 オブジェクトの各イメージの代替テキストの表示書式を指定する文字列。A string that specifies the format in which the alternate text for each image in an ImageField object is rendered. 既定値は空の文字列です ("")。この値は、代替テキストに適用される特定の書式が設定されていないことを示します。The default is an empty string (""), which indicates that now special formatting is applied to the alternate text.

次のコード例は、プロパティを使用して、 DataAlternateTextFormatString オブジェクト内のイメージの代替テキスト値にカスタム書式を適用する方法を示して ImageField います。The following code example demonstrates how to use the DataAlternateTextFormatString property to apply a custom format to the alternate text values for the images in an ImageField object.


<%@ 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 ます。Use the DataAlternateTextFormatString property to specify a custom format for the alternate text values of the images displayed in an ImageField object.

注意

書式指定文字列は、プロパティが設定されている場合にのみ適用され DataAlternateTextField ます。The format string is applied only when the DataAlternateTextField property is set. プロパティが設定されている場合は適用されません AlternateTextIt is not applied when the AlternateText property is set.

これは、フィールドに格納されている元の値を変更する必要がある場合に便利です。This is useful when you need to modify the original value contained in the field. プロパティが設定されていない場合は、 DataAlternateTextFormatString 代替テキスト値によって特殊な書式設定は取得されません。If the DataAlternateTextFormatString property is not set, the alternate text values do not get any special formatting.

書式指定文字列には、任意のリテラル文字列を指定できます。通常、フィールドの値のプレースホルダーが含まれています。The format string can be any literal string and usually contains a placeholder for the field's value. たとえば、書式文字列 "Item Value:" の場合、 {0} " {0} " プレースホルダーは、プロパティで指定されたフィールドの値に置き換えられ DataAlternateTextField ます。For example, in the format string "Item Value: {0}", the "{0}" placeholder is replaced with the value of the fields specified by the DataAlternateTextField property. 書式指定文字列の残りの部分は、リテラルテキストとして表示されます。The rest of the format string is displayed as literal text.

注意

書式指定文字列にプレースホルダーが含まれていない場合、データソースからのフィールドの値は、最終的な表示テキストには含まれません。If the format string does not include a placeholder, the field's value from the data source is not included in the final display text.

プレースホルダーは、コロン (":") で区切られた2つの部分で構成され、という形式で中かっこ (" {} ") で囲み {A:Bxx} ます。The placeholder consists of two parts separated by a colon (":") and wrapped in braces ("{}"), in the form {A:Bxx}. コロンの前の値 ( A 一般的な例では) は、0から始まるパラメーターのリストでフィールド値のインデックスを指定します。The value before the colon (A in the general example) specifies the field value's index in a zero-based list of parameters.

注意

このパラメーターは、書式設定の構文の一部です。This parameter is part of the formatting syntax. 各セルにはフィールド値が1つしかないので、この値は0にのみ設定できます。Because there is only one field value in each cell, this value can only be set to 0.

コロンとコロンの後の値は省略可能です。The colon and the values after the colon are optional. コロンの後の文字 ( B 一般的な例では) は、値を表示する形式を指定します。The character after the colon (B in the general example) specifies the format in which to display the value. 次の表は、共通の形式を示しています。The following table lists the common formats.

書式指定文字Format character 説明Description
C 通貨書式で数値を表示します。Displays numeric values in currency format.
D 数値を10進形式で表示します。Displays numeric values in decimal format.
E 指数 (指数) 形式で数値を表示します。Displays numeric values in scientific (exponential) format.
F 固定形式で数値を表示します。Displays numeric values in fixed format.
G 一般的な形式で数値を表示します。Displays numeric values in general format.
N 数値形式で数値を表示します。Displays numeric values in number format.
X 数値を16進形式で表示します。Displays numeric values in hexadecimal format.

注意

書式設定文字の大文字と小文字は区別されません。ただし、では X 、指定されたケースの16進文字が表示されます。The format characters are not case sensitive, except for X, which displays the hexadecimal characters in the case specified.

書式文字の後の値 (一般的な例では xx) は、表示する有効桁数または小数点以下の桁数を指定します。The value after the format character (xx in the general example) specifies the number of significant digits or decimal places to display. たとえば、"" という書式設定文字列では、 {0:F2} 小数点以下2桁の固定小数点数が表示されます。For example, the format string "{0:F2}" displays a fixed-point number with 2 decimal places.

書式設定の詳細については、「型の書式設定」を参照してください。For more information on formatting, see Formatting Types.

適用対象

こちらもご覧ください