.NET Framework Class Library ImageField Class Represents a field that is displayed as an image in a data-bound control.
Inheritance Hierarchy
Namespace:
System.Web.UI.WebControls
Assembly:
System.Web (in System.Web.dll)
Syntax
Public Class ImageField _
Inherits DataControlField
public class ImageField : DataControlField
public ref class ImageField : public DataControlField
type ImageField =
class
inherit DataControlField
end
The ImageField type exposes the following members.
Constructors
|
| Name | Description |
|---|
.gif) | ImageField | Initializes a new instance of the ImageField class. |
Top
Properties
Methods
Fields
Explicit Interface Implementations
Remarks
The ImageField class is used by data-bound controls (such as GridView and DetailsView) to display an image for each record displayed. The ImageField object is displayed differently depending on the data-bound control in which it is used. For example, the GridView control displays an ImageField object as a column, while the DetailsView control displays it as a row. To display images, you must bind an ImageField object to a field from a data source that contains the URL of an image. This is accomplished by setting the DataImageUrlField property. The URL value can be formatted by using the DataImageUrlFormatString property. Each image can also have alternate text associated with it. This text is displayed when an image cannot be loaded, or is unavailable. Browsers that support the ToolTips feature also display this text as a ToolTip. You can specify the alternate text for a displayed image by using one of the following methods: Use the AlternateText property to specify alternate text that applies to all images. Use the DataAlternateTextField property to bind a field from a data source to the AlternateText property of each image. This allows you to have different alternate text for each image displayed. When binding data, you can optionally format the alternate text by using the DataAlternateTextFormatString property.
When the URL value for an image is nullNothingnullptra null reference (Nothing in Visual Basic), an image cannot be displayed. You can display an alternate image for nullNothingnullptra null reference (Nothing in Visual Basic) field values by setting the NullImageUrl property. Instead of an alternate image, you can display alternate text by setting the NullDisplayText property. By default, all declared fields are displayed in a data-bound control. You can hide an ImageField object in a data-bound control by setting the Visible property to false. You can customize the header and footer sections of an ImageField object. To display a caption in the header or footer section, set the HeaderText or FooterText properties, respectively. To display an image in the header section instead of text, set the HeaderImageUrl property. The header section can be hidden in the ImageField object by setting the ShowHeader property to false. .gif) Note |
|---|
Some data-bound controls (such as the GridView control) can show or hide only the entire header section of the control. These data-bound controls do not support the ShowHeader property for an individual data-bound field. To show or hide the entire header section of a data-bound control, use the control's ShowHeader property (if available). |
You also can customize the appearance of the ImageField object (font color, background color, and so on) by setting the style properties for the different parts of the field. The following table lists the different style properties. Style property | Description |
|---|
ControlStyle | The style settings for the child Web server controls of the ImageField object. | FooterStyle | The style settings for the footer section of the ImageField object. | HeaderStyle | The style settings for the header section of the ImageField object. | ItemStyle | The style settings for the data items in the ImageField object. |
Examples
The following example demonstrates how to use an ImageField object in a GridView control to display an image.
<%@ Page language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html >
<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"
alternatetext="Employee Photo"
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="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html >
<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"
alternatetext="Employee Photo"
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>
Version Information
.NET FrameworkSupported in: 4, 3.5, 3.0, 2.0
Platforms
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role not supported), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Thread Safety
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also
|
Bibliothèque de classes .NET Framework ImageField, classe Représente un champ qui s'affiche en tant qu'image dans un contrôle lié aux données.
Hiérarchie d'héritage
Espace de noms :
System.Web.UI.WebControls
Assembly :
System.Web (dans System.Web.dll)
Syntaxe
Public Class ImageField _
Inherits DataControlField
public class ImageField : DataControlField
public ref class ImageField : public DataControlField
type ImageField =
class
inherit DataControlField
end
Le type ImageField expose les membres suivants.
Constructeurs
|
| Nom | Description |
|---|
| ImageField | Initialise une nouvelle instance de la classe ImageField. |
Début
Méthodes
Champs
Implémentations d'interface explicite
Notes
La classe ImageField est utilisée par les contrôles liés aux données (par exemple GridView et DetailsView) pour afficher une image pour chaque enregistrement affiché. L'affichage de l'objet ImageField varie en fonction du contrôle lié aux données dans lequel il est utilisé. Par exemple, le contrôle GridView affiche un objet ImageField comme une colonne, tandis que le contrôle DetailsView l'affiche comme une ligne. Pour afficher les images, vous devez lier un objet ImageField à un champ d'une source de données qui contient l'URL d'une image. Pour ce faire, définissez la propriété DataImageUrlField. La valeur de l'URL peut être mise en forme à l'aide de la propriété DataImageUrlFormatString. Chaque image peut également être associée à un texte de remplacement. Ce dernier s'affiche lorsqu'une image ne peut pas être chargée ou n'est pas disponible. Les navigateurs prenant en charge la fonctionnalité d'info-bulle affichent également ce texte sous forme d'info-bulle. Vous pouvez spécifier le texte de remplacement d'une image affichée en utilisant l'une des méthodes suivantes : Utilisez la propriété AlternateText pour spécifier le texte de remplacement qui s'applique à toutes les images. Utilisez la propriété DataAlternateTextField pour lier un champ d'une source de données à la propriété AlternateText de chaque image. Cela vous permet d'avoir un texte de remplacement différent pour chaque image affichée. Lorsque vous liez des données, vous pouvez mettre le texte de remplacement en forme en utilisant la propriété DataAlternateTextFormatString.
Lorsque la valeur d'URL d'une image est nullNothingnullptrune référence null (Nothing en Visual Basic), l'image ne peut pas être affichée. Vous pouvez afficher une image de remplacement pour les valeurs de champ nullNothingnullptrune référence null (Nothing en Visual Basic) en définissant la propriété NullImageUrl. Plutôt qu'une image de remplacement, vous pouvez afficher le texte de remplacement en définissant la propriété NullDisplayText. Par défaut, tous les champs déclarés sont affichés dans un contrôle lié aux données. Vous pouvez masquer un objet ImageField dans un contrôle lié aux données en attribuant à la propriété Visible la valeur false. Vous pouvez personnaliser les sections d'en-tête et de pied de page d'un objet ImageField. Pour afficher une légende dans la section d'en-tête ou de pied de page, définissez les propriétés HeaderText ou FooterText, respectivement. Pour afficher une image dans la section d'en-tête au lieu du texte, définissez la propriété HeaderImageUrl. La section d'en-tête peut être masquée dans l'objet ImageField en affectant la valeur false à la propriété ShowHeader. | Remarque |
|---|
Certains contrôles liés aux données (tels que le contrôle GridView) peuvent uniquement afficher ou masquer l'intégralité de la section d'en-tête du contrôle. Ces contrôles liés aux données ne prennent pas en charge la propriété ShowHeader pour un champ individuel lié aux données. Pour afficher ou masquer l'intégralité de la section d'en-tête d'un contrôle lié aux données, utilisez la propriété ShowHeader du contrôle (le cas échéant). |
Vous pouvez également personnaliser l'apparence de l'objet ImageField (couleur de police, couleur d'arrière-plan, etc.) en définissant les propriétés de style des différentes parties du champ. Le tableau suivant énumère les différentes propriétés de style. Propriété de style | Description |
|---|
ControlStyle | Paramètres de style des contrôles serveur Web enfants de l'objet ImageField. | FooterStyle | Paramètres de style de la section de pied de page de l'objet ImageField. | HeaderStyle | Paramètres de style de la section d'en-tête de l'objet ImageField. | ItemStyle | Paramètres de style des éléments de données de l'objet ImageField. |
Exemples
L'exemple suivant montre comment utiliser un objet ImageField dans un contrôle GridView pour afficher une image.
<%@ Page language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html >
<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"
alternatetext="Employee Photo"
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="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html >
<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"
alternatetext="Employee Photo"
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>
Informations de version
.NET FrameworkPris en charge dans : 4, 3.5, 3.0, 2.0
Plateformes
Windows 7, Windows Vista SP1 ou ultérieur, Windows XP SP3, Windows XP SP2 Édition x64, Windows Server 2008 (installation minimale non prise en charge), Windows Server 2008 R2 (installation minimale prise en charge avec SP1 ou version ultérieure), Windows Server 2003 SP2
Le .NET Framework ne prend pas en charge toutes les versions de chaque plateforme. Pour obtenir la liste des versions prises en charge, consultez Configuration requise du .NET Framework.
Sécurité des threads
Tous les membres static ( Shared en Visual Basic) publics de ce type sont thread-safe. Il n'est pas garanti que les membres d'instance soient thread-safe.
Voir aussi
|