ObjectList Class
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.
Caution
The System.Web.Mobile.dll assembly has been deprecated and should no longer be used. For information about how to develop ASP.NET mobile applications, see http://go.microsoft.com/fwlink/?LinkId=157231.
Enables you to specify multiple fields for display, per item in an object list. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET.
public ref class ObjectList : System::Web::UI::MobileControls::PagedControl, System::Web::UI::INamingContainer, System::Web::UI::IPostBackEventHandler, System::Web::UI::MobileControls::ITemplateable[System.Web.UI.MobileControls.DesignerAdapter(typeof(System.Web.UI.Design.MobileControls.Adapters.DesignerObjectListAdapter))]
public class ObjectList : System.Web.UI.MobileControls.PagedControl, System.Web.UI.INamingContainer, System.Web.UI.IPostBackEventHandler, System.Web.UI.MobileControls.ITemplateable[System.Web.UI.MobileControls.DesignerAdapter(typeof(System.Web.UI.Design.MobileControls.Adapters.DesignerObjectListAdapter))]
[System.Obsolete("The System.Web.Mobile.dll assembly has been deprecated and should no longer be used. For information about how to develop ASP.NET mobile applications, see http://go.microsoft.com/fwlink/?LinkId=157231.")]
public class ObjectList : System.Web.UI.MobileControls.PagedControl, System.Web.UI.INamingContainer, System.Web.UI.IPostBackEventHandler, System.Web.UI.MobileControls.ITemplateable[<System.Web.UI.MobileControls.DesignerAdapter(typeof(System.Web.UI.Design.MobileControls.Adapters.DesignerObjectListAdapter))>]
type ObjectList = class
inherit PagedControl
interface INamingContainer
interface ITemplateable
interface IPostBackEventHandler[<System.Web.UI.MobileControls.DesignerAdapter(typeof(System.Web.UI.Design.MobileControls.Adapters.DesignerObjectListAdapter))>]
[<System.Obsolete("The System.Web.Mobile.dll assembly has been deprecated and should no longer be used. For information about how to develop ASP.NET mobile applications, see http://go.microsoft.com/fwlink/?LinkId=157231.")>]
type ObjectList = class
inherit PagedControl
interface INamingContainer
interface ITemplateable
interface IPostBackEventHandlerPublic Class ObjectList
Inherits PagedControl
Implements INamingContainer, IPostBackEventHandler, ITemplateable- Inheritance
- Attributes
- Implements
Examples
The following code example demonstrates how to create an array of a user-defined class and then bind it to an ObjectList object when the page loads. It also shows how the list and details views display the commands. For this example, there is also a button that displays a form with a list of all the fields using the AllFields property.
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, see ASP.NET Web Forms Page Code Model.
<%@ Page Language="C#"
Inherits="System.Web.UI.MobileControls.MobilePage" %>
<%@ Register TagPrefix="mobile"
Namespace="System.Web.UI.MobileControls"
Assembly="System.Web.Mobile" %>
<script runat="server">
int bakeryCount = 0, dairyCount = 0, produceCount = 0;
public void Page_Load(Object o, EventArgs e)
{
if (!IsPostBack)
{ // Create an array and bind it to the list
ArrayList arr = new ArrayList();
arr.Add (new GroceryItem
("Bakery", "Rolls", "On Sale"));
arr.Add (new GroceryItem
("Dairy", "Eggnog", "Half price"));
arr.Add (new GroceryItem
("Produce", "Apples",
"A dollar a bushel"));
arr.Add (new GroceryItem
("Bakery", "Bread", "On Sale"));
List1.DataSource = arr;
List1.DataBind ();
// To show only one field on opening page,
// comment the next line
List1.TableFields = "Item;Department";
List1.LabelField = "Department";
// Display a report after items are databound
string txt = "Number of items by Department<br>Produce: {0}<br />" +
"Dairy: {1}<br />Bakery: {2}";
TextView2.Text = String.Format(txt, produceCount, dairyCount, bakeryCount);
}
}
// Command event for buttons
public void List1_Click(Object sender,
ObjectListCommandEventArgs e)
{
if (e.CommandName == "Reserve")
ActiveForm = Form2;
else if (e.CommandName == "Buy")
ActiveForm = Form3;
else
ActiveForm = Form4;
}
//<Snippet4>
// Count items in each department
private void List1_ItemDataBind(object sender, ObjectListDataBindEventArgs e)
{
switch (((GroceryItem)e.DataItem).Department)
{
case "Bakery":
bakeryCount++;
break;
case "Dairy":
dairyCount++;
break;
case "Produce":
produceCount++;
break;
}
}
//</Snippet4>
//<Snippet2>
private void AllFields_Click(object sender, EventArgs e)
{
ActiveForm = Form5;
string spec = "{0}: {1}<br/>";
IObjectListFieldCollection flds = List1.AllFields;
for (int i = 0; i < flds.Count; i++)
TextView1.Text +=
String.Format(spec, (i + 1), flds[i].Title);
}
//</Snippet2>
// Structure for ArrayList records
private class GroceryItem
{ // A private class for the Grocery List
private String _department, _item, _status;
public GroceryItem(string department,
string item, string status)
{
_department = department;
_item = item;
_status = status;
}
public String Department
{ get { return _department; } }
public String Item
{ get { return _item; } }
public String Status
{ get { return _status; } }
}
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<body>
<mobile:Form id="Form1" runat="server" BackColor="LightBlue">
<mobile:ObjectList id="List1" runat="server"
OnItemCommand="List1_Click" OnItemDataBind="List1_ItemDataBind">
<DeviceSpecific ID="DeviceSpecific1" Runat="server">
<!-- See Web.config for filters -->
<Choice Filter="isWML11" CommandStyle-Font-Bold="NotSet" />
<Choice CommandStyle-Font-Bold="true"
CommandStyle-Font-Name="Arial" />
</DeviceSpecific>
<Command Name="Reserve" Text="Reserve" />
<Command Name="Buy" Text="Buy" />
</mobile:ObjectList>
<mobile:Command ID="AllFieldsCmd" Runat="server"
OnClick="AllFields_Click">
List All Fields</mobile:Command>
<mobile:TextView ID="TextView2" Runat="server" />
</mobile:Form>
<mobile:Form id="Form2" runat="server" BackColor="LightBlue">
<mobile:Label id="ResLabel" runat="server"
text="Sale item reservation system coming soon!" />
<mobile:Link id="ResLink" NavigateURL="#Form1"
runat="server" text="Return" />
</mobile:Form>
<mobile:Form id="Form3" runat="server" BackColor="LightBlue">
<mobile:Label id="BuyLabel" runat="server"
Text="Online purchasing system coming soon!" />
<mobile:Link ID="BuyLink" NavigateURL="#Form1"
Runat="server" text="Return" />
</mobile:Form>
<mobile:Form id="Form4" Runat="server" BackColor="LightBlue">
<mobile:Label ID="DefLabel" Runat="server"
Text="Detailed item descriptions will be here soon!"/>
<mobile:Link ID="DefLink" NavigateURL="#Form1"
Runat="server" Text="Return" />
</mobile:Form>
<mobile:Form ID="Form5" Runat="server">
<mobile:Label Runat="server">
List of AllFields:</mobile:Label>
<mobile:TextView ID="TextView1" Runat="server" />
<mobile:Link Runat="server" NavigateUrl="#Form1"
Text="Return"></mobile:Link>
</mobile:Form>
</body>
</html>
<%@ Page Language="VB"
Inherits="System.Web.UI.MobileControls.MobilePage" %>
<%@ Register TagPrefix="mobile"
Namespace="System.Web.UI.MobileControls"
Assembly="System.Web.Mobile" %>
<script runat="server">
Dim bakeryCount, dairyCount, produceCount As Integer
Private Sub Page_Load(ByVal o As Object, ByVal e As EventArgs)
If Not IsPostBack Then
' Create an array and bind it to the list
Dim arr As New ArrayList()
arr.Add(New GroceryItem _
("Bakery", "Rolls", "On Sale"))
arr.Add(New GroceryItem _
("Dairy", "Eggnog", "Half price"))
arr.Add(New GroceryItem _
("Produce", "Apples", _
"A dollar a bushel"))
arr.Add(New GroceryItem _
("Bakery", "Bread", "On Sale"))
List1.DataSource = arr
List1.DataBind()
' To show only one field on opening page,
' comment the next line
List1.TableFields = "Item;Department"
List1.LabelField = "Department"
' Display a report after items are databound
Const txt As String = "Number of items by Department<br>Produce: " + _
"{0}<br />Dairy: {1}<br />Bakery: {2}"
TextView2.Text = String.Format(txt, produceCount, dairyCount, bakeryCount)
End If
End Sub
' Command event for buttons
Private Sub List1_Click(ByVal sender As Object, _
ByVal e As ObjectListCommandEventArgs)
If e.CommandName = "Reserve" Then
ActiveForm = Form2
ElseIf e.CommandName = "Buy" Then
ActiveForm = Form3
Else
ActiveForm = Form4
End If
End Sub
'<Snippet4>
' Count items in each department
Private Sub List1_ItemDataBind(ByVal sender As Object, ByVal e As ObjectListDataBindEventArgs)
Select Case CType(e.DataItem, GroceryItem).Department
Case "Bakery"
bakeryCount += 1
Case "Dairy"
dairyCount += 1
Case "Produce"
produceCount += 1
End Select
End Sub
'</Snippet4>
'<Snippet2>
Private Sub AllFields_Click(ByVal sender As Object, ByVal e As EventArgs)
ActiveForm = Form5
Dim spec As String = "{0}: {1}<br/>"
Dim flds As IObjectListFieldCollection = List1.AllFields
Dim i As Integer
For i = 0 To flds.Count - 1
TextView1.Text += _
String.Format(spec, (i + 1), flds(i).Title)
Next
End Sub
'</Snippet2>
' Structure for ArrayList records
Private Class GroceryItem
' A private class for the Grocery List
Private _department, _item, _status As String
Public Sub New(ByVal department As String, _
ByVal item As String, ByVal status As String)
_department = department
_item = item
_status = status
End Sub
Public ReadOnly Property Department() As String
Get
Return _department
End Get
End Property
Public ReadOnly Property Item() As String
Get
Return _item
End Get
End Property
Public ReadOnly Property Status() As String
Get
Return _status
End Get
End Property
End Class
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
<body>
<mobile:Form id="Form1" runat="server" BackColor="LightBlue">
<mobile:ObjectList id="List1" runat="server"
OnItemCommand="List1_Click" OnItemDataBind="List1_ItemDataBind">
<DeviceSpecific ID="DeviceSpecific1" Runat="server">
<!-- See Web.config for filters -->
<Choice Filter="isWML11" CommandStyle-Font-Bold="NotSet" />
<Choice CommandStyle-Font-Bold="true"
CommandStyle-Font-Name="Arial" />
</DeviceSpecific>
<Command Name="Reserve" Text="Reserve" />
<Command Name="Buy" Text="Buy" />
</mobile:ObjectList>
<mobile:Command ID="AllFieldsCmd" Runat="server"
OnClick="AllFields_Click">
List All Fields</mobile:Command>
<mobile:TextView ID="TextView2" Runat="server" />
</mobile:Form>
<mobile:Form id="Form2" runat="server" BackColor="LightBlue">
<mobile:Label id="ResLabel" runat="server"
text="Sale item reservation system coming soon!" />
<mobile:Link id="ResLink" NavigateURL="#Form1"
runat="server" text="Return" />
</mobile:Form>
<mobile:Form id="Form3" runat="server" BackColor="LightBlue">
<mobile:Label id="BuyLabel" runat="server"
Text="Online purchasing system coming soon!" />
<mobile:Link ID="BuyLink" NavigateURL="#Form1"
Runat="server" text="Return" />
</mobile:Form>
<mobile:Form id="Form4" Runat="server" BackColor="LightBlue">
<mobile:Label ID="DefLabel" Runat="server"
Text="Detailed item descriptions will be here soon!"/>
<mobile:Link ID="DefLink" NavigateURL="#Form1"
Runat="server" Text="Return" />
</mobile:Form>
<mobile:Form ID="Form5" Runat="server">
<mobile:Label ID="Label1" Runat="server">
List of AllFields:</mobile:Label>
<mobile:TextView ID="TextView1" Runat="server" />
<mobile:Link ID="Link1" Runat="server" NavigateUrl="#Form1"
Text="Return"></mobile:Link>
</mobile:Form>
</body>
</html>
This is a sample Web.config file with several device specific filters.
Remarks
Much of the behavior of the ObjectList, including support for templated rendering through device template sets and internal pagination, is similar to the behavior of the List. For more information, see the Introduction to the ObjectList Control or the Pagination documentation.
Constructors
| ObjectList() |
Creates a new instance of the ObjectList class. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
Properties
| Adapter |
Returns the device-specific adapter for the control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| Alignment |
Gets or sets the specified alignment for the style. The default value is NotSet. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| AllFields |
Returns the collection of all fields from the ObjectList class, whether explicit or automatically generated. The default value is the collection of automatically generated fields. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| AppRelativeTemplateSourceDirectory |
Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control) |
| AutoGenerateFields |
Specifies whether fields must be automatically generated from data. When enabled, each public property of the data becomes a field of the control. The default value is |
| BackColor |
Gets or sets the specified background color for the style. The default value is Empty. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| BackCommandText |
Gets or sets the text used for the command to return from the |
| BindingContainer |
Gets the control that contains this control's data binding. (Inherited from Control) |
| BreakAfter |
Gets or sets a property that determines whether an additional trailing break is rendered after the control. This break causes subsequent content to start on the next line. The default is |
| ChildControlsCreated |
Gets a value that indicates whether the server control's child controls have been created. (Inherited from Control) |
| ClientID |
Gets the control ID for HTML markup that is generated by ASP.NET. (Inherited from Control) |
| ClientIDMode |
Gets or sets the algorithm that is used to generate the value of the ClientID property. (Inherited from Control) |
| ClientIDSeparator |
Gets a character value representing the separator character used in the ClientID property. (Inherited from Control) |
| Commands |
Gets the collection of commands in the ObjectList object. Initially, the collection is empty. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| CommandStyle |
Gets or sets the style used for the object list commands. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| Context |
Gets the HttpContext object associated with the server control for the current Web request. (Inherited from Control) |
| Controls |
Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from Control) |
| CustomAttributes |
Returns the set of custom attributes defined for the control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| DataItemContainer |
Gets a reference to the naming container if the naming container implements IDataItemContainer. (Inherited from Control) |
| DataKeysContainer |
Gets a reference to the naming container if the naming container implements IDataKeysControl. (Inherited from Control) |
| DataMember |
Gets or sets the data member to extract when data binding to a list data source. The default value is an empty string (""). This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| DataSource |
Gets or sets the data source of the list that is being bound. The default value is null. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| DefaultCommand |
Gets or sets the name of the default command. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| DesignMode |
Gets a value indicating whether a control is being used on a design surface. (Inherited from Control) |
| Details |
Returns the panel that contains a device-specific details view. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| DetailsCommandText |
Gets or sets the text used for the menu item that shows the details view. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| DeviceSpecific |
Gets or sets the DeviceSpecific/Choice construct associated with the control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| EnableTheming |
Gets a value indicating whether themes apply to this control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| EnableViewState |
Gets or sets a value indicating whether the server control persists its view state, and the view state of any child controls it contains, to the requesting client. (Inherited from Control) |
| Events |
Gets a list of event handler delegates for the control. This property is read-only. (Inherited from Control) |
| Fields |
Gets the collection of explicitly defined fields in the ObjectListFieldCollection class. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| FirstPage |
Returns the first page of the form on which this control appears. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| FirstVisibleItemIndex |
Gets the first item visible on the current form page. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from PagedControl) |
| Font |
Gets a FontInfo object that contains font information about the control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| ForeColor |
Gets or sets the specified foreground color for the style. Typically, this property sets the color for the text. The default value is Empty. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| Form |
Provides access to the containing form. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| HasChildViewState |
Gets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control) |
| HasItemCommandHandler |
Gets a value indicating whether the ObjectList control has an event handler registered for the appropriate ItemCommand event. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| ID |
Gets or sets the programmatic identifier assigned to the server control. (Inherited from Control) |
| IdSeparator |
Gets the character used to separate control identifiers. (Inherited from Control) |
| InnerText |
Returns the text inside the control. The inner text might be a combination of text from child controls. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| InternalItemCount |
Gets the number of items in the control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| IsChildControlStateCleared |
Gets a value indicating whether controls contained within this control have control state. (Inherited from Control) |
| IsTemplated |
Gets a value indicating whether a MobileControl object has an active template set. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| IsTrackingViewState |
Gets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control) |
| IsViewStateEnabled |
Gets a value indicating whether view state is enabled for this control. (Inherited from Control) |
| ItemCount |
Gets or sets the count of items in the control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from PagedControl) |
| Items |
Gets the collection of items in an ObjectListItemCollection list. The default value is an empty collection. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| ItemsPerPage |
Gets or sets the number of items displayed per page after pagination. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from PagedControl) |
| ItemWeight |
Gets the approximate weight of a single item in the control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from PagedControl) |
| LabelField |
Gets or sets a value (the name or data field) that identifies the field to use as a label for each item. The default value is empty, which causes the first field in the AllFields collection to be used as a label for each item. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| LabelFieldIndex |
Gets the index in the AllFields collection of the field that has been set by the LabelField property. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| LabelStyle |
Gets or sets the style used for the header label. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| LastPage |
Returns the last page of the form on which the specified control is displayed. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| LoadViewStateByID |
Gets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control) |
| MobilePage |
Returns the containing page. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| MoreText |
Gets or sets the text string used for the |
| NamingContainer |
Gets a reference to the server control's naming container, which creates a unique namespace for differentiating between server controls with the same ID property value. (Inherited from Control) |
| Page |
Gets a reference to the Page instance that contains the server control. (Inherited from Control) |
| PaginateChildren |
Gets a value that indicates whether the children of the control must be paginated. Used for form pagination. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| Parent |
Gets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control) |
| RenderingCompatibility |
Gets a value that specifies the ASP.NET version that rendered HTML will be compatible with. (Inherited from Control) |
| SelectedIndex |
Returns the index of the selected item. The default value is |
| Selection |
Returns the selected item, or |
| SelectMoreCommand |
Gets the text used for the command to select more items in an ObjectList. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| Site |
Gets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control) |
| SkinID |
Gets the ID of the skin to apply to the control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| Style |
Gets the style of the control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| StyleReference |
Gets or sets a reference to the style properties for a control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| TableFieldIndices |
Gets an array of indices within the AllFields collection of the fields in the TableFields property. The default value is |
| TableFields |
Gets or sets which fields are visible when the list view is shown in table mode. The default value is an empty string (""). This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| TemplateControl |
Gets or sets a reference to the template that contains this control. (Inherited from Control) |
| TemplateSourceDirectory |
Gets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control) |
| UniqueID |
Gets the unique, hierarchically qualified identifier for the server control. (Inherited from Control) |
| ValidateRequestMode |
Gets or sets a value that indicates whether the control checks client input from the browser for potentially dangerous values. (Inherited from Control) |
| ViewMode |
Gets or sets the view mode of an ObjectList. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| ViewState |
Gets a dictionary of state information that allows you to save and restore the view state of a server control across multiple requests for the same page. (Inherited from Control) |
| ViewStateIgnoresCase |
Gets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control) |
| ViewStateMode |
Gets or sets the view-state mode of this control. (Inherited from Control) |
| Visible |
Gets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control) |
| VisibleItemCount |
Gets the number of items that are visible on the current ASP.NET mobile Web Forms page. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from PagedControl) |
| VisibleWeight |
Gets the approximate weight of the control, in characters. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from PagedControl) |
| Wrapping |
Gets or sets the specified wrapping mode for the style. The default value is NotSet. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
Methods
| AddedControl(Control, Int32) |
Called after a child control is added to the Controls collection of the Control object. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| AddLinkedForms(IList) |
Adds the set of forms that contains links to the specified control to the provided list. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| AddParsedSubObject(Object) |
Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's Controls property. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| ApplyStyleSheetSkin(Page) |
Applies the style properties defined in the page style sheet to the control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| BeginRenderTracing(TextWriter, Object) |
Begins design-time tracing of rendering data. (Inherited from Control) |
| BuildProfileTree(String, Boolean) |
Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page. (Inherited from Control) |
| ClearCachedClientID() |
Sets the cached ClientID value to |
| ClearChildControlState() |
Deletes the control-state information for the server control's child controls. (Inherited from Control) |
| ClearChildState() |
Deletes the view-state and control-state information for all the server control's child controls. (Inherited from Control) |
| ClearChildViewState() |
Deletes the view-state information for all the server control's child controls. (Inherited from Control) |
| ClearEffectiveClientIDMode() |
Sets the ClientIDMode property of the current control instance and of any child controls to Inherit. (Inherited from Control) |
| CreateAutoGeneratedFields(IEnumerable) |
Automatically generates fields for the given data. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| CreateChildControls() |
Notifies server controls to create any child controls in preparation for posting back or rendering. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| CreateControlCollection() |
Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control) |
| CreateDefaultTemplatedUI(Boolean) |
Called by device adapters to create the default templated user interface (UI) for the control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| CreateItem(Object) |
Creates a list item to contain the object and binds it to the specified object. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| CreateItems(IEnumerable) |
Creates items in an items collection from the specified |
| CreateStyle() |
Constructs and returns the style object to be associated with the control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| CreateTemplatedItemDetails(Boolean) |
Constructs the details view for the current item by using the |
| CreateTemplatedItemsList(Boolean) |
Constructs the list view by building templates. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| CreateTemplatedUI(Boolean) |
Called by base classes to create a templated UI. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| DataBind() |
Binds a data source to the ObjectList. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| DataBind(Boolean) |
Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event. (Inherited from Control) |
| DataBindChildren() |
Binds a data source to the server control's child controls. (Inherited from Control) |
| Dispose() |
Enables a server control to perform final clean up before it is released from memory. (Inherited from Control) |
| EndRenderTracing(TextWriter, Object) |
Ends design-time tracing of rendering data. (Inherited from Control) |
| EnsureChildControls() |
Determines whether the server control contains child controls. If it does not, it creates child controls. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| EnsureID() |
Creates an identifier for controls that do not have an identifier assigned. (Inherited from Control) |
| EnsureTemplatedUI() |
Use this method to ensure that the templates are instantiated to allow programmatic access to the instantiated contents of a template. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
| FindControl(String) |
Searches the current naming container for a server control with the specified |
| FindControl(String, Int32) |
Searches the current naming container for a server control with the specified |
| Focus() |
Sets input focus to a control. (Inherited from Control) |
| GetAttribute(String) |
Retrieves the specified attribute property from the control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| GetDesignModeState() |
Gets design-time data for a control. (Inherited from Control) |
| GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
| GetRouteUrl(Object) |
Gets the URL that corresponds to a set of route parameters. (Inherited from Control) |
| GetRouteUrl(RouteValueDictionary) |
Gets the URL that corresponds to a set of route parameters. (Inherited from Control) |
| GetRouteUrl(String, Object) |
Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control) |
| GetRouteUrl(String, RouteValueDictionary) |
Gets the URL that corresponds to a set of route parameters and a route name. (Inherited from Control) |
| GetTemplate(String) |
Returns the template with the specified name. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| GetUniqueIDRelativeTo(Control) |
Returns the prefixed portion of the UniqueID property of the specified control. (Inherited from Control) |
| HasControls() |
Determines if the server control contains any child controls. (Inherited from Control) |
| HasEvents() |
Returns a value indicating whether events are registered for the control or any child controls. (Inherited from Control) |
| IsFormSubmitControl() |
Returns |
| IsLiteralContent() |
Determines if the server control holds only literal content. (Inherited from Control) |
| IsVisibleOnPage(Int32) |
Returns whether or not the control is visible on the given page of the form. Used for form pagination. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| LoadControlState(Object) |
Restores control-state information from a previous page request that was saved by the SaveControlState() method. (Inherited from Control) |
| LoadPrivateViewState(Object) |
Loads private view state. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| LoadViewState(Object) |
Restores view-state information from a previous page request that was saved by the SaveViewState() method. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| MapPathSecure(String) |
Retrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| OnBubbleEvent(Object, EventArgs) |
Determines whether the event for the server control is passed up the page's UI server control hierarchy. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| OnDataBinding(EventArgs) |
Raises the DataBinding event. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| OnInit(EventArgs) |
Raises the Init event. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| OnItemCommand(ObjectListCommandEventArgs) |
Called when a list item generates an event as a result of user interaction. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| OnItemDataBind(ObjectListDataBindEventArgs) |
Called when a list item is data bound. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| OnItemSelect(ObjectListSelectEventArgs) |
Called after the user selects an item. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| OnLoad(EventArgs) |
Raises the Unload event. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| OnLoadItems(LoadItemsEventArgs) |
Called when the control is custom paginated and needs more data. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| OnPageChange(Int32, Int32) |
Paginates a control. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from PagedControl) |
| OnPreRender(EventArgs) |
Raises the PreRender event. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| OnRender(HtmlTextWriter) |
Renders a control to the specified output stream. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| OnShowItemCommands(ObjectListShowCommandsEventArgs) |
Called prior to showing the set of commands for a list item. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| OnUnload(EventArgs) |
Raises the Unload event. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| OpenFile(String) |
Gets a Stream used to read a file. (Inherited from Control) |
| PaginateRecursive(ControlPager) |
Paginates the control and its children. Called internally by ASP.NET. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from PagedControl) |
| PreShowItemCommands(Int32) |
Prepares the set of commands for a specified item prior to showing it, by calling any event handlers that might be set on the ShowItemCommands event. Called internally by ASP.NET. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| RaiseBubbleEvent(Object, EventArgs) |
Assigns any sources of the event and its information to the control's parent. (Inherited from Control) |
| RaiseDefaultItemEvent(Int32) |
Called to raise an event for the default command associated with the specified item. Called internally by the ASP.NET. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| RaisePostBackEvent(String) |
Notifies the ObjectList object of a postback event. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| RemovedControl(Control) |
Called after a child control is removed from the Controls collection of the Control object. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| Render(HtmlTextWriter) |
Sends server control content to a provided HtmlTextWriter object, which writes the content to be rendered on the client. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| RenderChildren(HtmlTextWriter) |
Outputs the content of a server control's child controls using the provided HtmlTextWriter. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| RenderControl(HtmlTextWriter) |
Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled. (Inherited from Control) |
| RenderControl(HtmlTextWriter, ControlAdapter) |
Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object. (Inherited from Control) |
| ResolveAdapter() |
Gets the control adapter responsible for rendering the specified control. (Inherited from Control) |
| ResolveClientUrl(String) |
Gets a URL that can be used by the browser. (Inherited from Control) |
| ResolveFormReference(String) |
Returns the form object referenced by the name parameter. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| ResolveUrl(String) |
Converts a URL into one that is usable on the requesting client. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| SaveControlState() |
Saves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control) |
| SavePrivateViewState() |
Saves any private view-state changes that have occurred since the page was loaded from persistence. If no changes were made, this method returns |
| SaveViewState() |
Saves any server control view-state changes that have occurred since the time the page was posted back to the server. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| SelectListItem(Int32, Boolean) |
Tests whether an item in an ObjectList is selected. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| SetAttribute(String, String) |
Designates an attribute and its value to assign to the MobileControl object. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| SetDesignModeState(IDictionary) |
Sets design-time data for a control. (Inherited from Control) |
| SetRenderMethodDelegate(RenderMethod) |
Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control) |
| SetTraceData(Object, Object) |
Sets trace data for design-time tracing of rendering data, using the trace data key and the trace data value. (Inherited from Control) |
| SetTraceData(Object, Object, Object) |
Sets trace data for design-time tracing of rendering data, using the traced object, the trace data key, and the trace data value. (Inherited from Control) |
| ToString() |
Returns a string that represents the current object. (Inherited from Object) |
| TrackViewState() |
Causes tracking of view-state changes to the server control so they can be stored in the server control's StateBag object. This object is accessible through the ViewState property. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
Events
| DataBinding |
Occurs when the server control binds to a data source. (Inherited from Control) |
| Disposed |
Occurs when a server control is released from memory, which is the last stage of the server control lifecycle when an ASP.NET page is requested. (Inherited from Control) |
| Init |
Occurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control) |
| ItemCommand |
Occurs when the user selects a command that is associated with an ObjectList item. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| ItemDataBind |
Occurs when an item in an ObjectList is bound to data. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| ItemSelect |
Occurs when a user selects an item from a list view. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| Load |
Occurs when the server control is loaded into the Page object. (Inherited from Control) |
| LoadItems |
Occurs when a control is custom-paginated and needs more data. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from PagedControl) |
| PreRender |
Occurs after the Control object is loaded but prior to rendering. (Inherited from Control) |
| ShowItemCommands |
Occurs before the commands related to an item in an ObjectList are shown. This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
| Unload |
Occurs when the server control is unloaded from memory. (Inherited from Control) |
Explicit Interface Implementations
| IAttributeAccessor.GetAttribute(String) |
For a description of this method, see GetAttribute(String). This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| IAttributeAccessor.SetAttribute(String, String) |
For a description of this member, see SetAttribute(String, String). This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. (Inherited from MobileControl) |
| IControlBuilderAccessor.ControlBuilder |
For a description of this member, see ControlBuilder. (Inherited from Control) |
| IControlDesignerAccessor.GetDesignModeState() |
For a description of this member, see GetDesignModeState(). (Inherited from Control) |
| IControlDesignerAccessor.SetDesignModeState(IDictionary) |
For a description of this member, see SetDesignModeState(IDictionary). (Inherited from Control) |
| IControlDesignerAccessor.SetOwnerControl(Control) |
For a description of this member, see SetOwnerControl(Control). (Inherited from Control) |
| IControlDesignerAccessor.UserData |
For a description of this member, see UserData. (Inherited from Control) |
| IDataBindingsAccessor.DataBindings |
For a description of this member, see DataBindings. (Inherited from Control) |
| IDataBindingsAccessor.HasDataBindings |
For a description of this member, see HasDataBindings. (Inherited from Control) |
| IExpressionsAccessor.Expressions |
For a description of this member, see Expressions. (Inherited from Control) |
| IExpressionsAccessor.HasExpressions |
For a description of this member, see HasExpressions. (Inherited from Control) |
| IParserAccessor.AddParsedSubObject(Object) |
For a description of this member, see AddParsedSubObject(Object). (Inherited from Control) |
| IPostBackEventHandler.RaisePostBackEvent(String) |
For a description of this member, see RaisePostBackEvent(String). This API is obsolete. For information about how to develop ASP.NET mobile applications, see Mobile Apps & Sites with ASP.NET. |
Extension Methods
| FindDataSourceControl(Control) |
Returns the data source that is associated with the data control for the specified control. |
| FindFieldTemplate(Control, String) |
Returns the field template for the specified column in the specified control's naming container. |
| FindMetaTable(Control) |
Returns the metatable object for the containing data control. |
| GetDefaultValues(INamingContainer) |
Gets the collection of the default values for the specified data control. |
| GetMetaTable(INamingContainer) |
Gets the table metadata for the specified data control. |
| SetMetaTable(INamingContainer, MetaTable) |
Sets the table metadata for the specified data control. |
| SetMetaTable(INamingContainer, MetaTable, IDictionary<String,Object>) |
Sets the table metadata and default value mapping for the specified data control. |
| SetMetaTable(INamingContainer, MetaTable, Object) |
Sets the table metadata and default value mapping for the specified data control. |
| TryGetMetaTable(INamingContainer, MetaTable) |
Determines whether table metadata is available. |
| EnableDynamicData(INamingContainer, Type) |
Enables Dynamic Data behavior for the specified data control. |
| EnableDynamicData(INamingContainer, Type, IDictionary<String,Object>) |
Enables Dynamic Data behavior for the specified data control. |
| EnableDynamicData(INamingContainer, Type, Object) |
Enables Dynamic Data behavior for the specified data control. |
Applies to
See also
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for