WebControl.BorderWidth Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Gets or sets the border width of the Web server control.
public:
virtual property System::Web::UI::WebControls::Unit BorderWidth { System::Web::UI::WebControls::Unit get(); void set(System::Web::UI::WebControls::Unit value); };
[System.ComponentModel.Bindable(true)]
public virtual System.Web.UI.WebControls.Unit BorderWidth { get; set; }
public virtual System.Web.UI.WebControls.Unit BorderWidth { get; set; }
[<System.ComponentModel.Bindable(true)>]
member this.BorderWidth : System.Web.UI.WebControls.Unit with get, set
member this.BorderWidth : System.Web.UI.WebControls.Unit with get, set
Public Overridable Property BorderWidth As Unit
Property Value
A Unit that represents the border width of a Web server control. The default value is Empty, which indicates that this property is not set.
- Attributes
Exceptions
The specified border width is a negative value.
Examples
The following example illustrates how to set the BorderWidth property of the Table control, inherited from the WebControl base class.
<%@ Page Language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
<title>Table Property</title>
</head>
<body>
<form id="form1" runat="server">
<div>
<h3>Property of a Table Web Control</h3>
<asp:Table id="Table1" runat="server"
CellPadding = "10"
CellSpacing="0"
GridLines="Both"
BorderColor="Red"
BorderWidth="3">
<asp:TableRow>
<asp:TableCell>
Row 0, Col 0
</asp:TableCell>
<asp:TableCell>
Row 0, Col 1
</asp:TableCell>
</asp:TableRow>
<asp:TableRow>
<asp:TableCell>
Row 1, Col 0
</asp:TableCell>
<asp:TableCell>
Row 1, Col 1
</asp:TableCell>
</asp:TableRow>
</asp:Table>
</div>
</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">
<script runat="server">
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
<title>Table Property</title>
</head>
<body>
<form id="form1" runat="server">
<div>
<h3>Property of a Table Web Control</h3>
<asp:Table id="Table1" runat="server"
CellPadding = "10"
CellSpacing="0"
GridLines="Both"
BorderColor="Red"
BorderWidth="3">
<asp:TableRow>
<asp:TableCell>
Row 0, Col 0
</asp:TableCell>
<asp:TableCell>
Row 0, Col 1
</asp:TableCell>
</asp:TableRow>
<asp:TableRow>
<asp:TableCell>
Row 1, Col 0
</asp:TableCell>
<asp:TableCell>
Row 1, Col 1
</asp:TableCell>
</asp:TableRow>
</asp:Table>
</div>
</form>
</body>
</html>
Note
The following code sample uses the single-file code model and may not work correctly if copied directly into a code-behind file. This code sample must be copied into an empty text file that has an .aspx extension. For more information on the Web Forms code model, see ASP.NET Web Forms Page Code Model.
<!-- This example demonstrates how to set property values for the
BorderColor, BorderStyle, and BorderWidth properties, and how to
change the property values at run time. -->
<!-- This example demonstrates how to set property values for the
BorderColor, BorderStyle, and BorderWidth properties, and how to
change the property values at run time. -->
<%@ Page language="c#" AutoEventWireup="true" %>
<%@ Import Namespace="System.Drawing" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
private void Page_Load(object sender, System.EventArgs e)
{
// Determine whether this is the first time the page is loaded;
// if so, load the drop-down lists with data.
if (!Page.IsPostBack)
{
// <Snippet4>
// Create a ListItemCollection and add names of colors.
ListItemCollection colors = new ListItemCollection();
colors.Add(Color.Black.Name);
colors.Add(Color.Blue.Name);
colors.Add(Color.Green.Name);
colors.Add(Color.Orange.Name);
colors.Add(Color.Purple.Name);
colors.Add(Color.Red.Name);
colors.Add(Color.White.Name);
colors.Add(Color.Yellow.Name);
// </Snippet4>
// Bind the colors collection to the borderColorList.
borderColorList.DataSource = colors;
borderColorList.DataBind();
// Create a ListItemCollection and the add names of
// the BorderStyle enumeration values.
ListItemCollection styles = new ListItemCollection();
foreach (string s in Enum.GetNames(typeof(BorderStyle)))
{
styles.Add(s);
}
// Bind the styles collection to the borderStyleList.
borderStyleList.DataSource = styles;
borderStyleList.DataBind();
// Create a ListItemCollection and add width values
// expressed in pixels (px).
ListItemCollection widths = new ListItemCollection();
for (int i = 0; i < 11; i++)
{
widths.Add(i.ToString() + "px");
}
// Bind the widths collection to the borderWidthList.
borderWidthList.DataSource = widths;
borderWidthList.DataBind();
}
}
// This method handles the SelectedIndexChanged event for borderColorList.
public void ChangeBorderColor(object sender, System.EventArgs e)
{
// <Snippet5>
// Convert the color name string to an object of type Color,
// and set the Color as the new border color for Label1.
Label1.BorderColor = Color.FromName(borderColorList.SelectedItem.Text);
// </Snippet5>
}
// This method handles the selectedIndexChanged event for boderStyleList.
public void ChangeBorderStyle(object sender, System.EventArgs e)
{
// <Snippet6>
// Convert the style name string to a BorderStyle enumeration value,
// and set the BorderStyle as the new border style for Label1.
Label1.BorderStyle = (BorderStyle)Enum.Parse(typeof(BorderStyle),
borderStyleList.SelectedItem.Text);
// </Snippet6>
}
// This method handles the SelectedIndexChanged event for borderWidthList.
public void ChangeBorderWidth(object sender, System.EventArgs e)
{
// <Snippet7>
// Convert the border width string to a object of type Unit,
// and set the Unit as the new border width for Label1.
Label1.BorderWidth = Unit.Parse(borderWidthList.SelectedItem.Text);
// </Snippet7>
}
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title> Border Properties Example </title>
</head>
<body>
<form id="form1" runat="server">
<h3> Border Properties Example </h3>
<table border="0" cellpadding="6">
<tr>
<td>
<asp:Label Runat="server" BorderColor="Black"
BorderStyle="Solid" BorderWidth="4px" ID="Label1"
Text="Border Properties Example" Height="75"
Width="200"><center><br />Border Properties Example
</center></asp:Label>
</td>
<td>
<asp:DropDownList Runat="server" ID="borderColorList"
OnSelectedIndexChanged="ChangeBorderColor" AutoPostBack="True"
EnableViewState="True"></asp:DropDownList>
<br />
<br />
<asp:DropDownList Runat="server" ID="borderStyleList"
OnSelectedIndexChanged="ChangeBorderStyle" AutoPostBack="True"
EnableViewState="True"></asp:DropDownList>
<br />
<br />
<asp:DropDownList Runat="server" ID="borderWidthList"
OnSelectedIndexChanged="ChangeBorderWidth" AutoPostBack="True"
EnableViewState="True"></asp:DropDownList>
</td>
</tr>
</table>
</form>
</body>
</html>
<%@ Page language="VB" AutoEventWireup="true" %>
<%@ Import Namespace="System.Drawing" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<script runat="server">
Private Sub Page_Load(sender As Object, e As System.EventArgs)
' Determine whether this is the first time the page is loaded;
' if so, load the drop-down lists with data.
If Not Page.IsPostBack Then
'<Snippet4>
' Create a ListItemCollection and add names of colors.
Dim colors As New ListItemCollection()
colors.Add(Color.Black.Name)
colors.Add(Color.Blue.Name)
colors.Add(Color.Green.Name)
colors.Add(Color.Orange.Name)
colors.Add(Color.Purple.Name)
colors.Add(Color.Red.Name)
colors.Add(Color.White.Name)
colors.Add(Color.Yellow.Name)
'</Snippet4>
' Bind the colors collection to the borderColorList.
borderColorList.DataSource = colors
borderColorList.DataBind()
' Create a ListItemCollection and the add names of
' the BorderStyle enumeration values.
Dim styles As New ListItemCollection()
Dim styleType As Type = GetType(BorderStyle)
Dim s As String
For Each s In [Enum].GetNames(styleType)
styles.Add(s)
Next s
' Bind the styles collection to the borderStyleList.
borderStyleList.DataSource = styles
borderStyleList.DataBind()
' Create a ListItemCollection and add width values
' expressed in pixels (px).
Dim widths As New ListItemCollection()
Dim i As Integer
For i = 0 To 10
widths.Add(i.ToString() & "px")
Next i
' Bind the widths collection to the borderWidthList.
borderWidthList.DataSource = widths
borderWidthList.DataBind()
End If
End Sub
' This method handles the SelectedIndexChanged event for borderColorList.
Public Sub ChangeBorderColor(sender As Object, e As System.EventArgs)
'<Snippet5>
' Convert the color name string to an object of type Color,
' and set the Color as the new border color for Label1.
Label1.BorderColor = Color.FromName(borderColorList.SelectedItem.Text)
'</Snippet5>
End Sub
' This method handles the selectedIndexChanged event for boderStyleList.
Public Sub ChangeBorderStyle(sender As Object, e As System.EventArgs)
'<Snippet6>
' Convert the style name string to a BorderStyle enumeration value,
' and set the BorderStyle as the new border style for Label1.
Dim styleType As Type = GetType(BorderStyle)
Label1.BorderStyle = [Enum].Parse(styleType, borderStyleList.SelectedItem.Text)
'</Snippet6>
End Sub
' This method handles the SelectedIndexChanged event for borderWidthList.
Public Sub ChangeBorderWidth(sender As Object, e As System.EventArgs)
'<Snippet7>
' Convert the border width string to a object of type Unit,
' and set the Unit as the new border width for Label1.
Label1.BorderWidth = Unit.Parse(borderWidthList.SelectedItem.Text)
'</Snippet7>
End Sub
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<head>
<title> Border Properties Example </title>
</head>
<body>
<form id="form1" runat="server">
<h3> Border Properties Example </h3>
<table border="0" cellpadding="6">
<tr>
<td>
<asp:Label Runat="server" BorderColor="Black"
BorderStyle="Solid" BorderWidth="4px" ID="Label1"
Text="Border Properties Example" Height="75"
Width="200"><center><br />Border Properties Example
</center></asp:Label>
</td>
<td>
<asp:DropDownList Runat="server" ID="borderColorList"
OnSelectedIndexChanged="ChangeBorderColor" AutoPostBack="True"
EnableViewState="True"></asp:DropDownList>
<br />
<br />
<asp:DropDownList Runat="server" ID="borderStyleList"
OnSelectedIndexChanged="ChangeBorderStyle" AutoPostBack="True"
EnableViewState="True"></asp:DropDownList>
<br />
<br />
<asp:DropDownList Runat="server" ID="borderWidthList"
OnSelectedIndexChanged="ChangeBorderWidth" AutoPostBack="True"
EnableViewState="True"></asp:DropDownList>
</td>
</tr>
</table>
</form>
</body>
</html>
Remarks
Use the BorderWidth property to specify a border width for a control.
Note
This property does not work with all Web server controls. It applies only to controls that display as a table, such as Table and DataGrid.
This property is set with a Unit object. If the Value property of the Unit contains a negative number, an exception is thrown.
Note
The border width can be expressed only in pixels for browsers earlier than Microsoft Internet Explorer version 5. All unit types are supported in Microsoft Internet Explorer version 5 and later. Refer to the specific control for details.