BulletedList class properties and its descriptions

Web developers use the BulletedList control to create a list of items that are formatted with bullets.  The list of items which appears in the control is built from individual ListItem object for each entry placed between the opening and closing tags of the BulletedList control. Web developer can determine how list items are displayed in a BulletedList control, by setting BulletStyle property to one of the bullet types that are defined by the BulletStyle enumeration:

–          NotSet – Not set.
–          Numbered – A number.
–          LowerAlpha – A lowercase letter.
–          UpperAlpha – An uppercase letter.
–          LowerRoman – A lowercase Roman numeral.
–          UpperRoman – An uppercase Roman numeral.
–          Disc – A filled circle.
–          Circle – An empty circle.
–          Square – A filled square.
–          CustomImage – A custom image.

Web developer should use the FirstBulletNumber property to specify the value that starts the numbering of list items in an ordered BulletedList control. The value that is assigned to the FirstBulletNumber property is ignored, if the BulletStyle property is set to the Disc, Square, Circle, or CustomImage field. If Web developer sets the BulletStyle property to the value of CustomImage, he/she must set the BulletImageUrl property also to specify the location of the image file.

Web developer can determine the display behavior of the list items in a BulletedList, by setting the DisplayMode property to one of the values that are defined by the BulletedListDisplayMode enumeration. The defined display behaviors are Text, HyperLink, and LinkButton.

The BulletedList control also supports data binding and Web developer can use any of the provided data-binding mechanisms.

Namespace: System.Web.UI.WebControls
Assembly: System.Web (in System.Web.dll)

Property

Description

Supported in .NET version

AccessKey

This property returns or sets the access key that allows software developer to quickly navigate to the Web server control.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

Adapter

This property gets the browser-specific adapter for the control.

2.0, 3.0, 3.5, 4.0

AppendDataBoundItems

The property gets or sets a value that indicates whether list items are cleared before data binding. The value of this property is stored in view state. Its default value is false. Its value is true if list items are not cleared before data binding; otherwise, false, if the items collection is cleared before data binding is performed. The AppendDataBoundItems property allows Web developers to add items to the ListControl object before data binding occurs. After data binding, the items collection contains both the items from the data source and the previously added items.

2.0, 3.0, 3.5, 4.0

AppRelativeTemplateSourceDirectory

 

Software developer can use this property to set or get the application-relative path to the page or user control that contains the current control.  If the web page is installed in http://www.somesite.com/apps/application1 the property will return “~/application1”.

2.0, 3.0, 3.5, 4.0

Attributes

This property is a collection which contains a collection of all attributes declared in the opening tag of a Web server control. Software developer can control programmatically the attributes associated with a Web server control. He/she can add or remove attributes to/from the collection.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

AutoPostBack

The property gets or sets a value indicating whether a postback to the server automatically occurs when the user changes the list selection. Its default value is false. Web developers should set its value to true if the server needs to capture the selection as soon as it is made. The value of this property is stored in view state.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

BackColor

The property is used to specify the background color of the Web server control. Software developer can set it using a System.Drawing..::.Color object.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

BindingContainer

Software developer can’t use this property directly from his/her code, because it supports the .NET Framework infrastructure.  The property contains a reference to the Control object which contains data-binding information for the current control.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

BorderColor

The property is used to specify the border color of the Web server control. Software developer can set it using a System.Drawing..::.Color object.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

BorderStyle

Specifies the type of the control’s border. Software developer can choose one of the values from the BorderStyle enumeration – Dashed, Dotted, Double, Grrove, Ridge, Inset, Outset, Solid and None.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

BorderWidth

Specifies the size of the control’s border.  When software developer sets this property he/she should use combination of a numeric value followed by type of measurement: px (for pixels) or % (for percentage) and so on.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

BulletImageUrl

This property is used to get or set the path to an image to display for each bullet in a BulletedList control. Web developers can specify a custom image for the bullets, by setting the BulletStyle property to the value CustomImage. Note: The BulletedList control does not support the AlternateText property because the bullets are inherently decorative and do not provide additional information that needs to be conveyed via assistive technology. If Web developers want to use a custom image to convey a concept to the user, they should add additional text to each of the bulleted list items or use a control that allows them to determine alternate text for each image.

Web developer can determine either a relative or an absolute path to the image. A relative path relates the location of the image to the location of the Web page without specifying a complete path on the server. The path is relative to the location of the Web page. This makes it easier to move the entire site to another directory on the server without updating the code.

2.0, 3.0, 3.5, 4.0

BulletStyle

This property gets or sets the bullet style for the BulletedList control. In the begging of this article the bullet types that are defined by the BulletStyle enumeration were presented. Note: The BulletedList control does not support the AlternateText property because the bullets are inherently decorative and do not provide additional information that needs to be conveyed via assistive technology. However, if Web developer wants to use a custom image to convey a concept to the user, he/she should add additional text to each of the bulleted list items or use a control that allows him/her to specify alternate text for each image.

The value of this property is stored in view state.

2.0, 3.0, 3.5, 4.0

CausesValidation

This property gets or sets a value indicating whether validation is performed when a control that is derived from the ListControl class is clicked. Its default value is false. Web developers should set its value to true if validation is performed when the ListControl control is clicked. In this case they can also use the ValidationGroup property to specify the name of the validation group for which the ListControl control causes validation.  The value of this property is stored in view state.

2.0, 3.0, 3.5, 4.0

ChildControlsCreated

Gets a true value that indicates whether the server control’s child controls have been created.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

ClientID

Returns the server control identifier generated by ASP.NET. The ClientID value is generated by concatenating the ID value of the control and the UniqueID value of its parent control. If the ID value of the control is not specified, an automatically generated value is used. Each part of the generated ID is separated by an underscore character (_).

1.0,1.1, 2.0, 3.0, 3.5, 4.0

ClientIDSeparator

The ClientID value is generated by concatenating the ID value of the control and the UniqueID value of its parent control. Each part of the generated ID property is separated by the ClientIDSeparator property value. The value always returns an underscore (_).

1.0,1.1, 2.0, 3.0, 3.5, 4.0

Context

Software developer can use this property to access the HttpContext object for the current Web request. Using properties of the object software developer can access objects Application, Session, Request, Response, etc. which contain information about the current HTTP request. The object provides methods that allow him to get configuration information and to set or clear errors related to the request.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

Controls

This property allows software developer to access programmatically to the instance of the ControlCollection class for any server control. Using it he/she can add/remove controls to/from the collection or iterate through the server controls in the collection.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

ControlStyle

This property is used to encapsulate all properties of the WebControl class that specify the appearance of the control, such as BorderColor and Font. This property is used primarily by control developers.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

ControlStyleCreated

This property is used primarily by control developers. Returns a true value if a Style object has been created for the ControlStyle property; otherwise false.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

CssClass

Software developer can use this property to specify the CSS class to render on the client for the Web Server control. This property will render on browsers for all controls. On browsers that do not support CSS, setting the CssClass property will have no effect.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

DataMember

The property is used to get or set the name of the list of data that the data-bound control binds to, in cases where the data source contains more than one distinct list of data items. Its default value is String.Empty. This property cannot be set by themes or style sheet themes. The value of the property is stored in view state.

2.0, 3.0, 3.5, 4.0

DataSource

The property gets or sets the object from which the data-bound control retrieves its list of data items. Its default value is null reference (Nothing in VB.NET). When Web developer set the DataSource property, the ValidateDataSource method is called. In addition, if the data-bound control has already been initialized, the OnDataPropertyChanged method is called to set the RequiresDataBinding property to true.

2.0, 3.0, 3.5, 4.0

DataSourceID

This property is used to get or set the ID of the control from which the data-bound control retrieves its list of data items.

2.0, 3.0, 3.5, 4.0

DataTextField

Web developers can use this property to get or set the field of the data source that provides the text content of the list items. Its default value is String.Empty. This property cannot be set by themes or style sheet themes. The value of this property is stored in view state.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

DataTextFormatString

The property is used to get or set the formatting string used to control how data bound to the list control is displayed. Its default value is String.Empty. The data format string consists of two parts, separated by a colon, in the form { A : Bxx }.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

DataValueField

The property gets or sets the field of the data source that provides the value of each list item. Its default value is String.Empty. This property cannot be set by themes or style sheet themes. The value of this property is stored in view state.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

DesignMode

This property returns true to indicate that the control is being used in the context of a designer. Software developer’s custom controls can use this property when design-time behavior is different than run-time behavior.

2.0, 3.0, 3.5, 4.0

DisplayMode

This property is used to get or set the display mode of the list content in a BulletedList control. The property is set using one of the BulletedListDisplayMode enumeration values:

– Text – Text.

– HyperLink – This value displays list content as hyperlinks. When clicked, a hyperlink navigates to a URL. Web developer should use the Value property to specify the URL that a hyperlink navigates to.

– LinkButton – This value displays list content as links. Web developer should use BulletedList.Click event to post back to the server when a link button is clicked.

The value of this property is stored in view state.

2.0, 3.0, 3.5, 4.0

Enabled

Software developer should set this property to true when he/she wants to specify or determine whether a control is functional. When developer sets to false, the control appears dimmed, preventing any input from being entered in the control. Notes:

  • Not all browsers support this property. Dimming and locking the control only works in browsers that are compatible with Microsoft Internet Explorer version 4 and later.
  • In a custom composite control, this behavior does not apply to controls that have not yet created their child controls.
  • A disabled control can support postbacks. It is possible for a user who is viewing the page with a disabled control to craft a request that submits a postback that is processed by the page.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

EnableTheming

This property overrides Control. EnableTheming.

The property indicates whether themes are enabled for a specified control. When the property’s value is true, the application’s theme directory is searched for control skins to apply. If for the particular control skin does not exist in the directory, skins are not applied. When the property’s value is false, the theme directory is not searched and the contents of the SkinID property are not used.

2.0, 3.0, 3.5, 4.0

EnableViewState

Software developer must enable view state for the server control setting its value to true if he/she wants to maintain its state across HTTP requests. Sometimes is better to set value of this property to false if for example Web application is loading a database request into a server control. In this case application performance will be improved.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

Events

This read-only property returns a list of event handler delegates for the control. The type of this property is EventHadlerList, which uses a linear search algorithm to find entries in the list of delegates. When the list of delegates is large, finding entries with this property will be slow, because a linear search algorithm is inefficient when working with a large number of entries.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

FirstBulletNumber

This property is used to get or set the value that starts the numbering of list items in an ordered BulletedList control. Its default value is 1.

2.0, 3.0, 3.5, 4.0

Font

Software developer can use this property to specify the font properties of the Web Server control. This property includes subproperties that can be accessed declaratively in the form of Property-Subproperty (for example Font-Bold) or programmatically in the form of Property.Subproperty (for example Font.Bold).

All but one subproperty will render in browsers prior to Microsoft Internet Explorer version 4 for all controls. They are: Bold, Italic, Name, Names, Strikeout, Underline, and Size (but only named font sizes, such as Small, Smaller, and so on, will work).

 

1.0,1.1, 2.0, 3.0, 3.5, 4.0

ForeColor

Software developer can use this property to to specify the foreground color of the Web server control. The foreground color is usually the color of the text. This property will render on browsers earlier than Microsoft Internet Explorer version 4 for all controls, except the Image, AdRotator, HyperLink and LinkButton.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

HasAttributes

This property returns true when the WebControl instance has attribute name/value pairs. The attribute pairs can be set either in the property or in the view state.

2.0, 3.0, 3.5, 4.0

HasChildViewState

Software developer can use this property to verify that any child controls of the server control are storing view-state information. Using it in this way he/she can avoid unnecessary calls to the ClearChildViewState method.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

Height

This property is used to specify the height of the Web server control. When software developer sets this property he/she should use combination of a numeric value followed by type of measurement: px (for pixels) or % (for percentage) and so on.This property does not render for all controls in browsers earlier than Microsoft Internet Explorer version 4. Controls that do not render this property in earlier browsers include Label, HyperLink, LinkButton, and any validation controls. The CheckBoxList, RadioButtonList and DataList also do not render this property in earlier browsers when their RepeatLayout property is set to RepeatLayout.Flow. Furthermore, only unit types of Pixel and Percentage are supported in earlier browsers.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

ID

Web developers can set this property by declaring ID attribute in the opening tag of an ASP.NET server control. Another possible way to set it is programmatically. If this property is not specified for a server control, either declaratively or programmatically, Web developer can obtain a reference to the control through its parent control’s Controls property.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

IdSeparator

Software developer can’t use this property directly from his/her code, because it supports the .NET Framework infrastructure.   The character contained in this property ( by default $ ) is used to separate the control identifiers for child controls. The ID separator character is appended to the ID property.

2.0, 3.0, 3.5, 4.0

Initialized

Returns a value (true) indicating whether the data-bound control has been initialized. The ConfirmInitState and OnPagePreLoad methods both explicitly set the Initialized property to true. The ConfirmInitState method is called by the DataBoundControl.OnLoad method, while OnPagePreLoad is called when the PreLoad event is raised.

2.0, 3.0, 3.5, 4.0

IsBoundUsingDataSourceID

This property returns value true if the DataSourceID property is set to value other than String.Empty; otherwise, the returned value is false.  Controls such as GridView, DetailsView, FormView, and Menu use the IsBoundUsingDataSourceID property to determine whether the data-bound control is bound to data source control, such as an ObjectDataSource or SqlDataSource.

2.0, 3.0, 3.5, 4.0

IsChildControlStateCleared

This property has value true if children of this control do not use control state; otherwise, false.

2.0, 3.0, 3.5, 4.0

IsEnabled

This property returns true if the Enabled property is true for this control and any containing controls.

2.0, 3.0, 3.5, 4.0

IsTrackingViewState

This property returns value true if the control is marked to save changes to its view state; otherwise, false.

 

1.0,1.1, 2.0, 3.0, 3.5, 4.0

IsViewStateEnabled

This property returns value true if view state is enabled for the control; otherwise false.  View state can be enabled at the page, container, or control level. When view state is disabled at the page or container level, view state is disabled for all controls contained by the page or container. The property indicates whether view state is enabled by pages, containers, or controls. In some cases it is possible values for the EnableViewState property and the IsViewStateEnabled property to be different. For example, if the Page containing the control has view state disabled, the EnableViewState property can be true while the IsViewStateEnabled property is false. Notes: Developers will set the EnableViewState property to indicate whether they are using view state with your control. Web developers can use this property in their code to determine whether view state is enabled for their control and all containers.

2.0, 3.0, 3.5, 4.0

Items

Returns the collection of items in the list control. This property can be used to specify the selected items in the list control.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

LoadViewStateByID

This property returns value true if the control loads its view state by ID; otherwise, false. Its default value is false.

2.0, 3.0, 3.5, 4.0

NamingContainer

Using this property software developer can get a reference to the server control’s naming container, which creates a unique namespace for differentiating between server controls with the same Control.ID property value.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

Page

Provides a reference to the web page that contains this control as a System.Web.UI.Page object.  This property’s value reflects the name of the .aspx file that contains the server control.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

Parent

This property provides a reference to the control that contains this control. If the control is placed on the page directly (rather than inside another control), it will return a reference to the page object.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

RequiresDataBinding

The property is used to get or set a value indicating whether the DataBind method should be called. The returned value is true if the data-bound control’s DataBind method should be called before the control is rendered; otherwise, the value is false.

2.0, 3.0, 3.5, 4.0

SelectArguments

Returns a DataSourceSelectArguments object used by data-bound control when retrieving data from a data source control.

2.0, 3.0, 3.5, 4.0

SelectedIndex

This property is used to get or set the lowest ordinal index of the selected items in the list. The value of the SelectedIndex property is not specifically saved on postback. It is restored on postback using the SelectedValue property.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

SelectedItem

Returns the selected item with the lowest index in the list control. The ListItem represents the lowest indexed item selected from the list control. Its default value is null reference (Nothing in Visual Basic). Web developers can use this property to get the individual properties of the selected item if the list control allows only a single selection. If the list control allows multiple selections, they can use this property to get the properties of the lowest indexed item selected from the list control.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

SelectedValue

Returns the value of the selected item in the list control, or selects the item in the list control that contains the specified value. This property returns the Value property of the selected ListItem. If no item is selected, an empty string (“”) is returned. The property can also be used to select an item in the list control by setting it with the value of the item. If no items in the list control contain the specified value, a System.ArgumentOutOfRangeException is thrown. This property cannot be set by themes or style sheet themes.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

Site

Using this property software developer can get information about the container that hosts the current control when rendered on a design surface.  A site binds a Component object to a Container object and enables communication between the two. It also provides a way for the container to manage its components.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

SkinID

This property overrides Control.SkinID.

Web developer can get or set the skin to apply to the control.  Skins available to a control are contained in one or more skin files in a theme directory. The SkinID property specifies which of these skins to apply to the control. A skin is specific to a particular control i.e. software developer cannot share skin setting between controls of different types. If developer does not set the SkinID property, a control uses the default skin if one is defined.

2.0, 3.0, 3.5, 4.0

Style

Web developer can use this property to get a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. This property will render on all browsers for all controls.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

TabIndex

With this number software developer can control the tab order. The control with a TabIndex of  zero has the focus when the page first loads. If end user presses Tab his/her focus will be moved to the control with the next lowest TabIndex. This property is available only in Internet Explorer 4.0 and higher.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

TagKey

Web developers can use this property to get the HtmlTextWriterTag value that corresponds to this Web server control. This property is used primarily by control developers.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

TagName

Web developers can use this property to get the name of the control tag. This property is used primarily by control developers.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

TemplateControl

This property is used to get or set a reference to the template that contains this control.

2.0, 3.0, 3.5, 4.0

TemplateSourceDirectory

Software developer can use this property to get the path to the page or user control that contains the current control.  If the web page is installed in http://www.somesite.com/apps/application1 the property will return “apps/application1”.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

Text

The property is used to get or set the SelectedValue property of the ListControl control. The SelectedValue property is commonly used to determine the value of the selected item in the ListControl control. If no item is selected, an empty string (“”) is returned. Web developers can also use the SelectedValue property to select an item in the ListControl control by setting it with the value of the item. If no items in the ListControl control contain the specified value, an System.ArgumentOutOfRangeException exception is thrown.

2.0, 3.0, 3.5, 4.0

ToolTip

This property displays a text message when the end users hover the mouse above the control.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

UniqueID

This property can be used to get the unique, hierarchically qualified identifier for the server control. This property differs from the ID property, in that the UniqueID property includes the identifier for the server control’s naming container. This identifier is generated automatically when a page request is processed. This property is particularly important in differentiating server controls contained within a data-binding server control that repeats as Repeater, DataList, DetailsView, FormView, and GridView Web server controls.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

ValidationGroup

The property is used to get or set the group of controls for which the control that is derived from the ListControl class causes validation when it posts back to the server. Validation groups allow Web developers to assign validation controls on a page to a specific category. Each validation group can be validated independently from other validation groups on the page. Web developers can use the ValidationGroup property to determine the name of the validation group for which the control that is derived from the ListControl class causes validation when it posts back to the server.

2.0, 3.0, 3.5, 4.0

ViewState

Web developers can use this property to get a dictionary of state information that allows them to save and restore the view state of a server control across multiple requests for the same page.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

ViewStateIgnoresCase

This property returns true if StateBag object is insensitive; otherwise, false. Its default value is false.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

Visible

Web developers can use this property to get or set a value that indicates whether a server control is rendered as UI on the page. If the control is visible on the page this property will has value true; otherwise false.

1.0,1.1, 2.0, 3.0, 3.5, 4.0

Width

This property is used to specify the width of the Web server control. When software developer sets this property he/she should use combination of a numeric value followed by type of measurement: px (for pixels) or % (for percentage) and so on.This property does not render for all controls in browsers earlier than Microsoft Internet Explorer version 4. Controls that do not render this property in earlier browsers include Label, HyperLink, LinkButton, and any validation controls. The CheckBoxList, RadioButtonList and DataList also do not render this property in earlier browsers when their RepeatLayout property is set to RepeatLayout.Flow. Furthermore, only unit types of Pixel and Percentage are supported in earlier browsers.

1.0,1.1, 2.0, 3.0, 3.5, 4.0