ServerCheckBoxList

V1.0 F1.7

File Name: Server_CheckBoxList.asp
Class Name: ServerCheckBoxList.asp

Overview

Renders a multiple- selection check box group that can be dynamically created by binding the control to a data source or by adding the items manually.

---

Public Constructors

	New_ServerCheckBoxList(name)	This constructor is used to create an instance of the control while at the same time assiging it a name and id.
	New	This is the default constructor and it will create an instance of the control without a name. Controls instanciated this way must assign the name of the control manually by doing this: <controlVariable>.Control.Name = "<ControlName>"

Public Properties

	Control	WebControl	Inherits attributes from WebControl.
	DataTextField	String	Gets/sets the field of the data source that provides the text content of the list items.
	DataValueField	String	Gets/sets the field of the data source that provides the value of each list item.
	ReadOnly	Boolean
	Items	ListItemsCollection
	AutoPostBack	Boolean	Gets/Sets a value indicating whether a postback to the server automatically occurs when the user changes the list selection.
	RepeatLayout	Int	1 Table , 2 Flow
	RepeatDirection	Int	Gets/Sets a value that indicates whether the control displays vertically or horizontally.
	RepeatColumns	Int	Gets/Sets the number of columns to display.
	TableCss	String	Gets/Sets the CSS Name for  the table (When RepeatLayout = 1)
	TableStyle	String	Gets/Sets the style for the table (When RepeatLayout = 1)
	BorderWidth	String	Gets/Sets the width of the table border (When RepeatLayout = 1)
	BorderColor	String	Gets/Sets the color of the table (When RepeatLayout = 1)
	GridLines	Boolean	Gets/Sets the wheter the table border is displayed or not (When RepeatLayout = 1)
	CellSpacing	Int	Gets/Sets the distance in pixels between the the border and the contents cells (only when RepeatLayout = 1)
	CellPadding	Int	Gets/Sets the distance in pixels between the cells (only when RepeatLayout = 1)

Public Methods

	(default) Render	Renders the control to the page.
	SetFromCache(XMLCache)	Used to set a cached XML representation of the ListItemsCollection.
	DataBind()	Binds the Contents of the DataSource and adds items to the ListItemsCollection. You must specify a DataSource and the DataTextField. You can provide the DataValueField which will be used to set the value of each checkbox, if not supplied then the Ordinal position will be used instead.

Public Events

<Control_Name>_Click()

This event is triggered if the AutoPostBack property is set to true.

Protected Properties

	mbolWasRendered	Boolean	True if the control was already rendered, otherwise false. This is needed by the ReadProperties when restoring from the viewstate as this type of input only post data in the form if checked. This makes difficult to determine if the value was not posted because the control was not rendered (visible=false, or other conditon in the page) or it was not checked. This value is stored in the viewstate of the control to support this determination.
	mPropBag	PropertyBag	Holds temporarily a reference the control viewstate (property bag) so it can later store if the control was or not rendered. (see above)

Protected Methods

	WriteProperties(bag)	Invoked by the CLASP Framework to allow the control to restore its state after a postback. Bag is of type PropertyBag and can be used to read (or write) to the control viewstate.
	ReadPropertied(bag)	Invoked by the CLASP Framework to allow the control to persist its state before the page is destroyed. Bag is of type PropertyBag and can be used to read (or write) to the control viewstate.
	RenderByColumn	Renders the list horizontally.
	RenderByRow	Renders the list vertically.

Protected Events

HandleClientEvent

Invoked by the CLASP Framework to allow the control to handle the postback event. From here the control can determine what is the course of action. In this case, if OnClick <> "" then it will invoke the function specified in the property, else it will invoke the default handler, if any.