Spring.NET 1.3.0 RC1 for .NET 2.0 API Reference

CheckBoxList Members

CheckBoxList overview

Public Instance Constructors

CheckBoxList Constructor Initializes a new instance of the CheckBoxList class.

Public Instance Properties

AccessKey (inherited from WebControl)Gets or sets the access key that allows you to quickly navigate to the Web server control.
AppendDataBoundItems (inherited from ListControl)Gets or sets a value that indicates whether list items are cleared before data binding.
AppRelativeTemplateSourceDirectory (inherited from Control)Gets or sets the application-relative virtual directory of the Page or UserControl object that contains this control.
Attributes (inherited from WebControl)Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.
AutoPostBack (inherited from ListControl)Gets or sets a value indicating whether a postback to the server automatically occurs when the user changes the list selection.
BackColor (inherited from WebControl)Gets or sets the background color of the Web server control.
BindingContainer (inherited from Control)Gets the control that contains this control's data binding.
BorderColor (inherited from WebControl)Gets or sets the border color of the Web control.
BorderStyle (inherited from WebControl)Gets or sets the border style of the Web server control.
BorderWidth (inherited from WebControl)Gets or sets the border width of the Web server control.
CausesValidation (inherited from ListControl)Gets or sets a value indicating whether validation is performed when a control that is derived from the ListControl class is clicked.
CellPadding (inherited from CheckBoxList)Gets or sets the distance (in pixels) between the border and contents of the cell.
CellSpacing (inherited from CheckBoxList)Gets or sets the distance (in pixels) between cells.
ClientID (inherited from Control)Gets the server control identifier generated by ASP.NET.
Controls (inherited from Control)Gets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy.
ControlStyle (inherited from WebControl)Gets the style of the Web server control. This property is used primarily by control developers.
ControlStyleCreated (inherited from WebControl)Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers.
CssClass (inherited from WebControl)Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.
DataMember (inherited from DataBoundControl)Gets or sets 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.
DataSource (inherited from BaseDataBoundControl)Gets or sets the object from which the data-bound control retrieves its list of data items.
DataSourceID (inherited from DataBoundControl)Gets or sets the ID of the control from which the data-bound control retrieves its list of data items.
DataSourceObject (inherited from DataBoundControl) 
DataTextField (inherited from ListControl)Gets or sets the field of the data source that provides the text content of the list items.
DataTextFormatString (inherited from ListControl)Gets or sets the formatting string used to control how data bound to the list control is displayed.
DataValueField (inherited from ListControl)Gets or sets the field of the data source that provides the value of each list item.
Enabled (inherited from WebControl)Gets or sets a value indicating whether the Web server control is enabled.
EnableTheming (inherited from WebControl)Gets or sets a value indicating whether themes apply to this control.
EnableViewState (inherited from Control)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.
Font (inherited from WebControl)Gets the font properties associated with the Web server control.
ForeColor (inherited from WebControl)Gets or sets the foreground color (typically the color of the text) of the Web server control.
HasAttributes (inherited from WebControl)Gets a value indicating whether the control has attributes set.
Height (inherited from WebControl)Gets or sets the height of the Web server control.
ID (inherited from Control)Gets or sets the programmatic identifier assigned to the server control.
Items (inherited from ListControl)Gets the collection of items in the list control.
NamingContainer (inherited from Control)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.
Page (inherited from Control)Gets a reference to the Page instance that contains the server control.
Parent (inherited from Control)Gets a reference to the server control's parent control in the page control hierarchy.
RepeatColumns (inherited from CheckBoxList)Gets or sets the number of columns to display in the CheckBoxList control.
RepeatDirection (inherited from CheckBoxList)Gets or sets a value that indicates whether the control displays vertically or horizontally.
RepeatLayout (inherited from CheckBoxList)Gets or sets the layout of the check boxes.
SelectedIndex (inherited from ListControl)Gets or sets the lowest ordinal index of the selected items in the list.
SelectedItem (inherited from ListControl)Gets the selected item with the lowest index in the list control.
SelectedValue (inherited from ListControl)Gets the value of the selected item in the list control, or selects the item in the list control that contains the specified value.
SelectedValues Gets or Sets the list of selected values and checks the CheckBoxes accordingly
Site (inherited from Control)Gets information about the container that hosts the current control when rendered on a design surface.
SkinID (inherited from WebControl)Gets or sets the skin to apply to the control.
Style (inherited from WebControl)Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control.
TabIndex (inherited from WebControl)Gets or sets the tab index of the Web server control.
TemplateControl (inherited from Control)Gets or sets a reference to the template that contains this control.
TemplateSourceDirectory (inherited from Control)Gets the virtual directory of the Page or UserControl that contains the current server control.
Text (inherited from ListControl)Gets or sets the SelectedValue property of the ListControl control.
TextAlign (inherited from CheckBoxList)Gets or sets the text alignment for the check boxes within the group.
ToolTip (inherited from WebControl)Gets or sets the text displayed when the mouse pointer hovers over the Web server control.
UniqueID (inherited from Control)Gets the unique, hierarchically qualified identifier for the server control.
ValidationGroup (inherited from ListControl)Gets or sets the group of controls for which the control that is derived from the ListControl class causes validation when it posts back to the server.
Visible (inherited from Control)Gets or sets a value that indicates whether a server control is rendered as UI on the page.
Width (inherited from WebControl)Gets or sets the width of the Web server control.

Public Instance Methods

ApplyStyle (inherited from WebControl)Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.
ApplyStyleSheetSkin (inherited from Control)Applies the style properties defined in the page style sheet to the control.
ClearSelection (inherited from ListControl)Clears out the list selection and sets the Selected property of all items to false.
CopyBaseAttributes (inherited from WebControl)Copies the properties not encapsulated by the Style object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.
DataBind (inherited from BaseDataBoundControl)Overloaded. Binds a data source to the invoked server control and all its child controls.
Dispose (inherited from Control)Enables a server control to perform final clean up before it is released from memory.
Equals (inherited from Object)Determines whether the specified Object is equal to the current Object.
FindControl (inherited from Control)Overloaded. Searches the current naming container for a server control with the specified id parameter.
Focus (inherited from Control)Sets input focus to a control.
GetHashCode (inherited from Object)Serves as a hash function for a particular type. GetHashCode is suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object)Gets the Type of the current instance.
HasControls (inherited from Control)Determines if the server control contains any child controls.
MergeStyle (inherited from WebControl)Copies any nonblank elements of the specified style to the Web control, but will not overwrite any existing style elements of the control. This method is used primarily by control developers.
RenderBeginTag (inherited from WebControl)Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers.
RenderControl (inherited from Control)Overloaded. Outputs server control content to a provided HtmlTextWriter object and stores tracing information about the control if tracing is enabled.
RenderEndTag (inherited from WebControl)Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers.
ResolveClientUrl (inherited from Control)Gets a URL that can be used by the browser.
ResolveUrl (inherited from Control)Converts a URL into one that is usable on the requesting client.
SetRenderMethodDelegate (inherited from Control)Assigns an event handler delegate to render the server control and its content into its parent control.
ToString (inherited from Object)Returns a String that represents the current Object.

Public Instance Events

DataBinding (inherited from Control)Occurs when the server control binds to a data source.
DataBound (inherited from BaseDataBoundControl)Occurs after the server control binds to a data source.
Disposed (inherited from Control)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.
Init (inherited from Control)Occurs when the server control is initialized, which is the first step in its lifecycle.
Load (inherited from Control)Occurs when the server control is loaded into the Page object.
PreRender (inherited from Control)Occurs after the Control object is loaded but prior to rendering.
SelectedIndexChanged (inherited from ListControl)Occurs when the selection from the list control changes between posts to the server.
TextChanged (inherited from ListControl)Occurs when the Text and SelectedValue properties change.
Unload (inherited from Control)Occurs when the server control is unloaded from memory.

Protected Instance Properties

Adapter (inherited from Control)Gets the browser-specific adapter for the control.
ChildControlsCreated (inherited from Control)Gets a value that indicates whether the server control's child controls have been created.
ClientIDSeparator (inherited from Control)Gets a character value representing the separator character used in the ClientID property.
Context (inherited from Control)Gets the HttpContext object associated with the server control for the current Web request.
DesignMode (inherited from Control)Gets a value indicating whether a control is being used on a design surface.
Events (inherited from Control)Gets a list of event handler delegates for the control. This property is read-only.
HasChildViewState (inherited from Control)Gets a value indicating whether the current server control's child controls have any saved view-state settings.
HasFooter (inherited from CheckBoxList)Gets a value indicating whether the CheckBoxList control contains a footer section.
HasHeader (inherited from CheckBoxList)Gets a value indicating whether the CheckBoxList control contains a heading section.
HasSeparators (inherited from CheckBoxList)Gets a value indicating whether the CheckBoxList control contains a separator between items in the list.
IdSeparator (inherited from Control)Gets the character used to separate control identifiers.
Initialized (inherited from BaseDataBoundControl)Gets a value indicating whether the data-bound control has been initialized.
IsBoundUsingDataSourceID (inherited from BaseDataBoundControl)Gets a value indicating whether the DataSourceID property is set.
IsChildControlStateCleared (inherited from Control)Gets a value indicating whether controls contained within this control have control state.
IsEnabled (inherited from WebControl)Gets a value indicating whether the control is enabled.
IsTrackingViewState (inherited from Control)Gets a value that indicates whether the server control is saving changes to its view state.
IsViewStateEnabled (inherited from Control)Gets a value indicating whether view state is enabled for this control.
LoadViewStateByID (inherited from Control)Gets a value indicating whether the control participates in loading its view state by ID instead of index.
RepeatedItemCount (inherited from CheckBoxList)Gets the number of list items in the CheckBoxList control.
RequiresDataBinding (inherited from BaseDataBoundControl)Gets or sets a value indicating whether the DataBind method should be called.
SelectArguments (inherited from DataBoundControl)Gets a DataSourceSelectArguments object that the data-bound control uses when retrieving data from a data source control.
TagKey (inherited from ListControl)Gets the HtmlTextWriterTag value for the ListControl control.
TagName (inherited from WebControl)Gets the name of the control tag. This property is used primarily by control developers.
ViewState (inherited from Control)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.
ViewStateIgnoresCase (inherited from Control)Gets a value that indicates whether the StateBag object is case-insensitive.

Protected Instance Methods

AddAttributesToRender (inherited from ListControl)Applies HTML attributes and styles to render to the specified T:System.Web.UI.HtmlTextWriterms-help://MS.VSCC.v80/MS.MSDNQTR.v80.en/MS.MSDN.v80/MS.NETDEVFX.v20.en/cpref/html/T_System_Web_UI_HtmlTextWriter.htm object.
AddedControl (inherited from Control)Called after a child control is added to the Controls collection of the Control object.
AddParsedSubObject (inherited from Control)Notifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object.
BuildProfileTree (inherited from Control)Gathers information about the server control and delivers it to the Trace property to be displayed when tracing is enabled for the page.
ClearChildControlState (inherited from Control)Deletes the control-state information for the server control's child controls.
ClearChildState (inherited from Control)Deletes the view-state and control-state information for all the server control's child controls.
ClearChildViewState (inherited from Control)Deletes the view-state information for all the server control's child controls.
ConfirmInitState (inherited from BaseDataBoundControl)Sets the initialized state of the data-bound control.
CreateChildControls (inherited from Control)Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering.
CreateControlCollection (inherited from Control)Creates a new ControlCollection object to hold the child controls (both literal and server) of the server control.
CreateControlStyle (inherited from CheckBoxList)Creates a style object that is used internally by the CheckBoxList control to implement all style related properties.
CreateDataSourceSelectArguments (inherited from DataBoundControl)Creates a default DataSourceSelectArguments object used by the data-bound control if no arguments are specified.
DataBind (inherited from Control)Overloaded. Binds a data source to the invoked server control and all its child controls with an option to raise the DataBinding event.
DataBindChildren (inherited from Control)Binds a data source to the server control's child controls.
EnsureChildControls (inherited from Control)Determines whether the server control contains child controls. If it does not, it creates child controls.
EnsureDataBound (inherited from BaseDataBoundControl)Calls the DataBind method if the DataSourceID property is set and the data-bound control is marked to require binding.
EnsureID (inherited from Control)Creates an identifier for controls that do not have an identifier assigned.
Finalize (inherited from Object)Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
FindControl (inherited from CheckBoxList)Overloaded. Searches the current naming container for a server control with the specified ID and path offset. The FindControl method always returns the CheckBoxList object.
GetData (inherited from DataBoundControl)Retrieves a DataSourceView object that the data-bound control uses to perform data operations.
GetDataSource (inherited from DataBoundControl)Retrieves the IDataSource interface that the data-bound control is associated with, if any.
GetDesignModeState (inherited from Control)Gets design-time data for a control.
GetItemStyle (inherited from CheckBoxList)Retrieves the style of the specified item type at the specified index in the list control.
HasEvents (inherited from Control)Returns a value indicating whether events are registered for the control or any child controls.
IsLiteralContent (inherited from Control)Determines if the server control holds only literal content.
LoadControlState (inherited from Control)Restores control-state information from a previous page request that was saved by the SaveControlState method.
LoadPostData (inherited from CheckBoxList)Processes the posted data for the CheckBoxList control.
LoadViewState (inherited from ListControl)Loads the previously saved view state of the DetailsView control.
MapPathSecure (inherited from Control)Retrieves the physical path that a virtual path, either absolute or relative, maps to.
MarkAsDataBound (inherited from DataBoundControl)Sets the state of the control in view state as successfully bound to data.
MemberwiseClone (inherited from Object)Creates a shallow copy of the current Object.
OnBubbleEvent (inherited from Control)Determines whether the event for the server control is passed up the page's UI server control hierarchy.
OnDataBinding (inherited from ListControl)Raises the DataBinding event.
OnDataBound (inherited from BaseDataBoundControl)Raises the DataBound event.
OnDataPropertyChanged (inherited from DataBoundControl)Rebinds the data-bound control to its data after one of the base data source identification properties changes.
OnDataSourceViewChanged (inherited from DataBoundControl)Raises the DataSourceViewChanged event.
OnInit (inherited from BaseDataBoundControl)Handles the Init event.
OnLoad (inherited from DataBoundControl)Handles the Load event.
OnPagePreLoad (inherited from DataBoundControl)Sets the initialized state of the data-bound control before the control is loaded.
OnPreRender (inherited from CheckBoxList)Configures the CheckBoxList control prior to rendering on the client.
OnSelectedIndexChanged (inherited from ListControl)Raises the SelectedIndexChanged event. This allows you to provide a custom handler for the event.
OnTextChanged (inherited from ListControl)Raises the TextChanged event.
OnUnload (inherited from Control)Raises the Unload event.
OpenFile (inherited from Control)Gets a Stream used to read a file.
PerformDataBinding (inherited from ListControl)Binds the specified data source to the control that is derived from the ListControl class.
PerformSelect (inherited from ListControl)Retrieves data from the associated data source.
RaiseBubbleEvent (inherited from Control)Assigns any sources of the event and its information to the control's parent.
RaisePostDataChangedEvent (inherited from CheckBoxList)Notifies the ASP.NET application that the state of the CheckBoxList control has changed.
RemovedControl (inherited from Control)Called after a control is removed from the Controls collection of another control.
Render (inherited from CheckBoxList)Displays the CheckBoxList on the client.
RenderChildren (inherited from Control)Outputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client.
RenderContents (inherited from ListControl)Renders the items in the ListControl control.
RenderControl (inherited from Control)Overloaded. Outputs server control content to a provided HtmlTextWriter object using a provided ControlAdapter object.
RenderItem (inherited from CheckBoxList)Renders a list item in the CheckBoxList control.
ResolveAdapter (inherited from Control)Gets the control adapter responsible for rendering the specified control.
SaveControlState (inherited from Control)Saves any server control state changes that have occurred since the time the page was posted back to the server.
SaveViewState (inherited from ListControl)Saves the current view state of the ListControl -derived control and the items it contains.
SetDesignModeState (inherited from Control)Sets design-time data for a control.
SetPostDataSelection (inherited from ListControl)Sets the Selected property of a ListItem control after a page is posted.
TrackViewState (inherited from ListControl)Marks the starting point to begin tracking and saving view-state changes to a ListControl -derived control.
ValidateDataSource (inherited from DataBoundControl)Verifies that the object a data-bound control binds to is one it can work with.
VerifyMultiSelect (inherited from ListControl)Determines whether the list control supports multiselection mode.

Explicit Interface Implementations

IAttributeAccessor.GetAttribute (inherited from WebControl) 
IAttributeAccessor.SetAttribute (inherited from WebControl) 
IControlDesignerAccessor.GetDesignModeState (inherited from Control) 
IControlDesignerAccessor.SetDesignModeState (inherited from Control) 
IControlDesignerAccessor.SetOwnerControl (inherited from Control) 
IParserAccessor.AddParsedSubObject (inherited from Control) 
IPostBackDataHandler.LoadPostData (inherited from CheckBoxList) 
IPostBackDataHandler.RaisePostDataChangedEvent (inherited from CheckBoxList) 
IRepeatInfoUser.GetItemStyle (inherited from CheckBoxList) 
IRepeatInfoUser.RenderItem (inherited from CheckBoxList) 

See Also

CheckBoxList Class | Spring.Web.UI.Controls Namespace