Click to Rate and Give Feedback
MSDN
MSDN Library
.NET Development
.NET Framework 3.5
CheckBoxList Class
 CheckBoxList Members

  Switch on low bandwidth view
Members FilterMembers Filter
Frameworks FilterFrameworks Filter
This page is specific to
Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:
.NET Framework Class Library
CheckBoxList Members

Creates a multi selection check box group that can be dynamically created by binding the control to a data source.

The CheckBoxList type exposes the following members.

  NameDescription
Public methodCheckBoxList Initializes a new instance of the CheckBoxList class.
Top
  NameDescription
Protected methodAddAttributesToRenderOverloaded.
Protected methodAddedControlCalled after a child control is added to the Controls collection of the Control object. (Inherited from Control.)
Protected methodAddParsedSubObjectNotifies the server control that an element, either XML or HTML, was parsed, and adds the element to the server control's ControlCollection object. (Inherited from Control.)
Public methodApplyStyle 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. (Inherited from WebControl.)
Public methodApplyStyleSheetSkinApplies the style properties defined in the page style sheet to the control. (Inherited from Control.)
Protected methodBuildProfileTreeInfrastructure. 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.)
Protected methodClearChildControlStateDeletes the control-state information for the server control's child controls. (Inherited from Control.)
Protected methodClearChildStateDeletes the view-state and control-state information for all the server control's child controls. (Inherited from Control.)
Protected methodClearChildViewStateDeletes the view-state information for all the server control's child controls. (Inherited from Control.)
Public methodClearSelectionClears out the list selection and sets the Selected property of all items to false. (Inherited from ListControl.)
Protected methodConfirmInitState Sets the initialized state of the data-bound control. (Inherited from BaseDataBoundControl.)
Public methodCopyBaseAttributes 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. (Inherited from WebControl.)
Protected methodCreateChildControlsCalled 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. (Inherited from Control.)
Protected methodCreateControlCollectionCreates a new ControlCollection object to hold the child controls (both literal and server) of the server control. (Inherited from Control.)
Protected methodCreateControlStyleInfrastructure. Creates a style object that is used internally by the CheckBoxList control to implement all style related properties. (Overrides WebControl..::.CreateControlStyle()()().)
Protected methodCreateDataSourceSelectArguments Creates a default DataSourceSelectArguments object used by the data-bound control if no arguments are specified. (Inherited from DataBoundControl.)
Public methodDataBindOverloaded. Binds a data source to the invoked server control and all its child controls.
Protected methodDataBindChildrenBinds a data source to the server control's child controls. (Inherited from Control.)
Public methodDisposeEnables a server control to perform final clean up before it is released from memory. (Inherited from Control.)
Protected methodEnsureChildControlsDetermines whether the server control contains child controls. If it does not, it creates child controls. (Inherited from Control.)
Protected methodEnsureDataBound Calls the DataBind method if the DataSourceID property is set and the data-bound control is marked to require binding. (Inherited from BaseDataBoundControl.)
Protected methodEnsureIDCreates an identifier for controls that do not have an identifier assigned. (Inherited from Control.)
Public methodEquals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalize Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodFindControlOverloaded. Searches the current naming container for the specified server control.
Public methodFocusSets input focus to a control. (Inherited from Control.)
Protected methodGetData Retrieves a DataSourceView object that the data-bound control uses to perform data operations. (Inherited from DataBoundControl.)
Protected methodGetDataSource Retrieves the IDataSource interface that the data-bound control is associated with, if any. (Inherited from DataBoundControl.)
Protected methodGetDesignModeStateInfrastructure. Gets design-time data for a control. (Inherited from Control.)
Public methodGetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Protected methodGetItemStyle Retrieves the style of the specified item type at the specified index in the list control.
Public methodGetType Gets the Type of the current instance. (Inherited from Object.)
Public methodHasControlsDetermines if the server control contains any child controls. (Inherited from Control.)
Protected methodHasEventsReturns a value indicating whether events are registered for the control or any child controls. (Inherited from Control.)
Protected methodIsLiteralContentInfrastructure. Determines if the server control holds only literal content. (Inherited from Control.)
Protected methodLoadControlStateRestores control-state information from a previous page request that was saved by the SaveControlState method. (Inherited from Control.)
Protected methodLoadPostData Processes the posted data for the CheckBoxList control.
Protected methodLoadViewStateLoads the previously saved view state of the DetailsView control. (Inherited from ListControl.)
Protected methodMapPathSecureRetrieves the physical path that a virtual path, either absolute or relative, maps to. (Inherited from Control.)
Protected methodMarkAsDataBound Sets the state of the control in view state as successfully bound to data. (Inherited from DataBoundControl.)
Protected methodMemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public methodMergeStyle 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. (Inherited from WebControl.)
Protected methodOnBubbleEventDetermines whether the event for the server control is passed up the page's UI server control hierarchy. (Inherited from Control.)
Protected methodOnDataBindingInfrastructure. Raises the DataBinding event. (Inherited from ListControl.)
Protected methodOnDataBound Raises the DataBound event. (Inherited from BaseDataBoundControl.)
Protected methodOnDataPropertyChanged Rebinds the data-bound control to its data after one of the base data source identification properties changes. (Inherited from DataBoundControl.)
Protected methodOnDataSourceViewChanged Raises the DataSourceViewChanged event. (Inherited from DataBoundControl.)
Protected methodOnInitOverloaded.
Protected methodOnLoadOverloaded.
Protected methodOnPagePreLoad Sets the initialized state of the data-bound control before the control is loaded. (Inherited from DataBoundControl.)
Protected methodOnPreRender Configures the CheckBoxList control prior to rendering on the client. (Overrides ListControl..::.OnPreRender(EventArgs).)
Protected methodOnSelectedIndexChangedRaises the SelectedIndexChanged event. This allows you to provide a custom handler for the event. (Inherited from ListControl.)
Protected methodOnTextChangedRaises the TextChanged event. (Inherited from ListControl.)
Protected methodOnUnloadRaises the Unload event. (Inherited from Control.)
Protected methodOpenFileGets a Stream used to read a file. (Inherited from Control.)
Protected methodPerformDataBindingInfrastructure. Binds the specified data source to the control that is derived from the ListControl class. (Inherited from ListControl.)
Protected methodPerformSelectRetrieves data from the associated data source. (Inherited from ListControl.)
Protected methodRaiseBubbleEventAssigns any sources of the event and its information to the control's parent. (Inherited from Control.)
Protected methodRaisePostDataChangedEvent Notifies the ASP.NET application that the state of the CheckBoxList control has changed.
Protected methodRemovedControlCalled after a child control is removed from the Controls collection of the Control object. (Inherited from Control.)
Protected methodRender Displays the CheckBoxList on the client. (Overrides WebControl..::.Render(HtmlTextWriter).)
Public methodRenderBeginTag Renders the HTML opening tag of the control to the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Protected methodRenderChildrenOutputs the content of a server control's children to a provided HtmlTextWriter object, which writes the content to be rendered on the client. (Inherited from Control.)
Protected methodRenderContentsOverloaded.
Public methodRenderControlOverloaded. Outputs server control content and stores tracing information about the control if tracing is enabled.
Public methodRenderEndTag Renders the HTML closing tag of the control into the specified writer. This method is used primarily by control developers. (Inherited from WebControl.)
Protected methodRenderItem Renders a list item in the CheckBoxList control.
Protected methodResolveAdapterGets the control adapter responsible for rendering the specified control. (Inherited from Control.)
Public methodResolveClientUrlGets a URL that can be used by the browser. (Inherited from Control.)
Public methodResolveUrlConverts a URL into one that is usable on the requesting client. (Inherited from Control.)
Protected methodSaveControlStateSaves any server control state changes that have occurred since the time the page was posted back to the server. (Inherited from Control.)
Protected methodSaveViewStateSaves the current view state of the ListControl -derived control and the items it contains. (Inherited from ListControl.)
Protected methodSetDesignModeStateSets design-time data for a control. (Inherited from Control.)
Protected methodSetPostDataSelectionInfrastructure. Sets the Selected property of a ListItem control after a page is posted. (Inherited from ListControl.)
Public methodSetRenderMethodDelegateInfrastructure. Assigns an event handler delegate to render the server control and its content into its parent control. (Inherited from Control.)
Public methodToString Returns a String that represents the current Object. (Inherited from Object.)
Protected methodTrackViewStateMarks the starting point to begin tracking and saving view-state changes to a ListControl -derived control. (Inherited from ListControl.)
Protected methodValidateDataSource Verifies that the object a data-bound control binds to is one it can work with. (Inherited from DataBoundControl.)
Protected methodVerifyMultiSelectInfrastructure. Determines whether the list control supports multiselection mode. (Inherited from ListControl.)
Top
  NameDescription
Public Extension MethodEnablePersistedSelection Enables selection to be persisted in data controls that support selection and paging. (Defined by DynamicDataExtensions.)
Public Extension MethodFindDataSourceControl Returns the data source that is associated with the data control for the specified control. (Defined by DynamicDataExtensions.)
Public Extension MethodFindFieldTemplate Returns the field template for the specified column within the specified control's naming container. (Defined by DynamicDataExtensions.)
Public Extension MethodFindMetaTable Returns the MetaTable object for the containing data control. (Defined by DynamicDataExtensions.)
Top
  NameDescription
Public propertyAccessKey Gets or sets the access key that allows you to quickly navigate to the Web server control. (Inherited from WebControl.)
Protected propertyAdapterGets the browser-specific adapter for the control. (Inherited from Control.)
Public propertyAppendDataBoundItemsGets or sets a value that indicates whether list items are cleared before data binding. (Inherited from ListControl.)
Public propertyAppRelativeTemplateSourceDirectoryGets or sets the application-relative virtual directory of the Page or UserControl object that contains this control. (Inherited from Control.)
Public propertyAttributes Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control. (Inherited from WebControl.)
Public propertyAutoPostBackGets or sets a value indicating whether a postback to the server automatically occurs when the user changes the list selection. (Inherited from ListControl.)
Public propertyBackColor Gets or sets the background color of the Web server control. (Inherited from WebControl.)
Public propertyBindingContainerInfrastructure. Gets the control that contains this control's data binding. (Inherited from Control.)
Public propertyBorderColor Gets or sets the border color of the Web control. (Inherited from WebControl.)
Public propertyBorderStyle Gets or sets the border style of the Web server control. (Inherited from WebControl.)
Public propertyBorderWidth Gets or sets the border width of the Web server control. (Inherited from WebControl.)
Public propertyCausesValidationGets or sets a value indicating whether validation is performed when a control that is derived from the ListControl class is clicked. (Inherited from ListControl.)
Public propertyCellPadding Gets or sets the distance (in pixels) between the border and contents of the cell.
Public propertyCellSpacing Gets or sets the distance (in pixels) between cells.
Protected propertyChildControlsCreatedGets a value that indicates whether the server control's child controls have been created. (Inherited from Control.)
Public propertyClientIDGets the server control identifier generated by ASP.NET. (Inherited from Control.)
Protected propertyClientIDSeparatorGets a character value representing the separator character used in the ClientID property. (Inherited from Control.)
Protected propertyContextGets the HttpContext object associated with the server control for the current Web request. (Inherited from Control.)
Public propertyControlsGets a ControlCollection object that represents the child controls for a specified server control in the UI hierarchy. (Inherited from Control.)
Public propertyControlStyle Gets the style of the Web server control. This property is used primarily by control developers. (Inherited from WebControl.)
Public propertyControlStyleCreated Gets a value indicating whether a Style object has been created for the ControlStyle property. This property is primarily used by control developers. (Inherited from WebControl.)
Public propertyCssClass Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client. (Inherited from WebControl.)
Public propertyDataMemberOverloaded.
Public propertyDataSourceOverloaded.
Public propertyDataSourceID Gets or sets the ID of the control from which the data-bound control retrieves its list of data items. (Inherited from DataBoundControl.)
Public propertyDataSourceObject Gets an object that implements the IDataSource interface, which provides access to the object's data content. (Inherited from DataBoundControl.)
Public propertyDataTextFieldGets or sets the field of the data source that provides the text content of the list items. (Inherited from ListControl.)
Public propertyDataTextFormatStringGets or sets the formatting string used to control how data bound to the list control is displayed. (Inherited from ListControl.)
Public propertyDataValueFieldGets or sets the field of the data source that provides the value of each list item. (Inherited from ListControl.)
Protected propertyDesignModeGets a value indicating whether a control is being used on a design surface. (Inherited from Control.)
Public propertyEnabled Gets or sets a value indicating whether the Web server control is enabled. (Inherited from WebControl.)
Public propertyEnableTheming Gets or sets a value indicating whether themes apply to this control. (Inherited from WebControl.)
Public propertyEnableViewStateGets 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.)
Protected propertyEventsGets a list of event handler delegates for the control. This property is read-only. (Inherited from Control.)
Public propertyFont Gets the font properties associated with the Web server control. (Inherited from WebControl.)
Public propertyForeColor Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from WebControl.)
Public propertyHasAttributes Gets a value indicating whether the control has attributes set. (Inherited from WebControl.)
Protected propertyHasChildViewStateGets a value indicating whether the current server control's child controls have any saved view-state settings. (Inherited from Control.)
Protected propertyHasFooter Gets a value indicating whether the CheckBoxList control contains a footer section.
Protected propertyHasHeader Gets a value indicating whether the CheckBoxList control contains a heading section.
Protected propertyHasSeparators Gets a value indicating whether the CheckBoxList control contains a separator between items in the list.
Public propertyHeight Gets or sets the height of the Web server control. (Inherited from WebControl.)
Public propertyIDGets or sets the programmatic identifier assigned to the server control. (Inherited from Control.)
Protected propertyIdSeparatorInfrastructure. Gets the character used to separate control identifiers. (Inherited from Control.)
Protected propertyInitialized Gets a value indicating whether the data-bound control has been initialized. (Inherited from BaseDataBoundControl.)
Protected propertyIsBoundUsingDataSourceID Gets a value indicating whether the DataSourceID property is set. (Inherited from BaseDataBoundControl.)
Protected propertyIsChildControlStateClearedGets a value indicating whether controls contained within this control have control state. (Inherited from Control.)
Protected propertyIsEnabled Gets a value indicating whether the control is enabled. (Inherited from WebControl.)
Protected propertyIsTrackingViewStateGets a value that indicates whether the server control is saving changes to its view state. (Inherited from Control.)
Protected propertyIsViewStateEnabledGets a value indicating whether view state is enabled for this control. (Inherited from Control.)
Public propertyItemsGets the collection of items in the list control. (Inherited from ListControl.)
Protected propertyLoadViewStateByIDGets a value indicating whether the control participates in loading its view state by ID instead of index. (Inherited from Control.)
Public propertyNamingContainerGets 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. (Inherited from Control.)
Public propertyPageGets a reference to the Page instance that contains the server control. (Inherited from Control.)
Public propertyParentGets a reference to the server control's parent control in the page control hierarchy. (Inherited from Control.)
Public propertyRepeatColumns Gets or sets the number of columns to display in the CheckBoxList control.
Public propertyRepeatDirection Gets or sets a value that indicates whether the control displays vertically or horizontally.
Protected propertyRepeatedItemCount Gets the number of list items in the CheckBoxList control.
Public propertyRepeatLayout Gets or sets the layout of the check boxes.
Protected propertyRequiresDataBinding Gets or sets a value indicating whether the DataBind method should be called. (Inherited from BaseDataBoundControl.)
Protected propertySelectArguments Gets a DataSourceSelectArguments object that the data-bound control uses when retrieving data from a data source control. (Inherited from DataBoundControl.)
Public propertySelectedIndexGets or sets the lowest ordinal index of the selected items in the list. (Inherited from ListControl.)
Public propertySelectedItemGets the selected item with the lowest index in the list control. (Inherited from ListControl.)
Public propertySelectedValueGets the value of the selected item in the list control, or selects the item in the list control that contains the specified value. (Inherited from ListControl.)
Public propertySiteGets information about the container that hosts the current control when rendered on a design surface. (Inherited from Control.)
Public propertySkinID Gets or sets the skin to apply to the control. (Inherited from WebControl.)
Public propertyStyle Gets a collection of text attributes that will be rendered as a style attribute on the outer tag of the Web server control. (Inherited from WebControl.)
Public propertyTabIndex Gets or sets the tab index of the Web server control. (Inherited from WebControl.)
Protected propertyTagKeyOverloaded.
Protected propertyTagName Gets the name of the control tag. This property is used primarily by control developers. (Inherited from WebControl.)
Public propertyTemplateControlGets or sets a reference to the template that contains this control. (Inherited from Control.)
Public propertyTemplateSourceDirectoryGets the virtual directory of the Page or UserControl that contains the current server control. (Inherited from Control.)
Public propertyTextGets or sets the SelectedValue property of the ListControl control. (Inherited from ListControl.)
Public propertyTextAlign Gets or sets the text alignment for the check boxes within the group.
Public propertyToolTip Gets or sets the text displayed when the mouse pointer hovers over the Web server control. (Inherited from WebControl.)
Public propertyUniqueIDGets the unique, hierarchically qualified identifier for the server control. (Inherited from Control.)
Public propertyValidationGroupGets 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. (Inherited from ListControl.)
Protected propertyViewStateGets 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.)
Protected propertyViewStateIgnoresCaseGets a value that indicates whether the StateBag object is case-insensitive. (Inherited from Control.)
Public propertyVisibleGets or sets a value that indicates whether a server control is rendered as UI on the page. (Inherited from Control.)
Public propertyWidth Gets or sets the width of the Web server control. (Inherited from WebControl.)
Top
  NameDescription
Public eventDataBindingOccurs when the server control binds to a data source. (Inherited from Control.)
Public eventDataBound Occurs after the server control binds to a data source. (Inherited from BaseDataBoundControl.)
Public eventDisposedOccurs 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.)
Public eventInitOccurs when the server control is initialized, which is the first step in its lifecycle. (Inherited from Control.)
Public eventLoadOccurs when the server control is loaded into the Page object. (Inherited from Control.)
Public eventPreRenderOccurs after the Control object is loaded but prior to rendering. (Inherited from Control.)
Public eventSelectedIndexChangedOccurs when the selection from the list control changes between posts to the server. (Inherited from ListControl.)
Public eventTextChangedOccurs when the Text and SelectedValue properties change. (Inherited from ListControl.)
Public eventUnloadOccurs when the server control is unloaded from memory. (Inherited from Control.)
Top
  NameDescription
Explicit interface implemetationPrivate methodIParserAccessor..::.AddParsedSubObjectFor a description of this member, see IParserAccessor..::.AddParsedSubObject. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIControlBuilderAccessor..::.ControlBuilderFor a description of this member, see IControlBuilderAccessor..::.ControlBuilder. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIDataBindingsAccessor..::.DataBindingsFor a description of this member, see IDataBindingsAccessor..::.DataBindings. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIExpressionsAccessor..::.ExpressionsFor a description of this member, see IExpressionsAccessor..::.Expressions. (Inherited from Control.)
Explicit interface implemetationPrivate methodIAttributeAccessor..::.GetAttributeInfrastructure. Gets an attribute of the Web control with the specified name. (Inherited from WebControl.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor..::.GetDesignModeStateFor a description of this member, see IControlDesignerAccessor..::.GetDesignModeState. (Inherited from Control.)
Explicit interface implemetationPrivate methodIRepeatInfoUser..::.GetItemStyleInfrastructure. For a description of this member, see IRepeatInfoUser..::.GetItemStyle.
Explicit interface implemetationPrivate propertyIDataBindingsAccessor..::.HasDataBindingsFor a description of this member, see IDataBindingsAccessor..::.HasDataBindings. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIExpressionsAccessor..::.HasExpressionsFor a description of this member, see IExpressionsAccessor..::.HasExpressions. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIRepeatInfoUser..::.HasFooterInfrastructure. Gets a value that indicates whether the list control contains a footer section.
Explicit interface implemetationPrivate propertyIRepeatInfoUser..::.HasHeaderInfrastructure. Gets a value that indicates whether the list control contains a heading section.
Explicit interface implemetationPrivate propertyIRepeatInfoUser..::.HasSeparatorsInfrastructure. Gets a value that indicates whether the list control contains a separator between items in the list.
Explicit interface implemetationPrivate methodIPostBackDataHandler..::.LoadPostDataInfrastructure. Processes posted data for the CheckBoxList control.
Explicit interface implemetationPrivate methodIPostBackDataHandler..::.RaisePostDataChangedEventInfrastructure. Raised when posted data for a control has changed.
Explicit interface implemetationPrivate methodIRepeatInfoUser..::.RenderItemInfrastructure. For a description of this member, see RenderItem.
Explicit interface implemetationPrivate propertyIRepeatInfoUser..::.RepeatedItemCountInfrastructure. Gets the number of items in the list control.
Explicit interface implemetationPrivate methodIAttributeAccessor..::.SetAttribute Sets an attribute of the Web control to the specified name and value. (Inherited from WebControl.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor..::.SetDesignModeStateFor a description of this member, see IControlDesignerAccessor..::.SetDesignModeState. (Inherited from Control.)
Explicit interface implemetationPrivate methodIControlDesignerAccessor..::.SetOwnerControlInfrastructure. For a description of this member, see IControlDesignerAccessor..::.SetOwnerControl. (Inherited from Control.)
Explicit interface implemetationPrivate propertyIControlDesignerAccessor..::.UserDataFor a description of this member, see IControlDesignerAccessor..::.UserData. (Inherited from Control.)
Top
Tags What's this?: Add a tag
Community Content   What is Community Content?
Add new content RSS  Annotations
Processing
© 2009 Microsoft Corporation. All rights reserved. Terms of Use  |  Trademarks  |  Privacy Statement
Page view tracker