metabuilders.webcontrols.dynamiclistbox.xml

实现DualList列表的Web自定义控件

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>MetaBuilders.WebControls.DynamicListBox</name>
    </assembly>
    <members>
        <member name="T:MetaBuilders.WebControls.DualList">
            <summary>
            Provides the UI for the common requirement of two listboxes with items that move between them.
            </summary>
            <remarks>
            <p>When DataBinding is used, the control will automaticly remove items from the left side if they exist on the right side. This ensures that double items can't be chosen.</p>
            <p>
            For browsers that support scripting, the movement will be completely clientside. There is also 100% serverside support, for any browsers with script disabled or nonexistant.
            </p>
            <p>By default, the clientscript used by the control is emited directly into the page.
            In order to save bandwidth, it's possible to have the control to use a script reference instead,
            but this requires the following handler to be added to the httpHandlers section of web.config.</p>
            <code>
            &lt;httpHandlers&gt;
            	&lt;add verb="*"
            		path="MetaBuilders_WebControls_DynamicListBoxResourceHandler.axd"
            		type="MetaBuilders.WebControls.DynamicListBoxResourceHandler,MetaBuilders.WebControls.DynamicListBox"
            		validate="false"
            	/&gt;
            &lt;/httpHandlers&gt;
            </code>
            </remarks>
            <example>
            The following is a simple example that uses this control.
            <code><![CDATA[
            <%@ Register TagPrefix="mbdlb" Namespace="MetaBuilders.WebControls" Assembly="MetaBuilders.WebControls.DynamicListBox" %>
            <script runat="server" language="c#" >
            	protected void DualList1_ItemsMoved( Object sender, EventArgs e ) {
            		DualResult.Text = "The Chosen Items Are:";
            		foreach( ListItem item in DualList1.RightBox.Items ) {
            			DualResult.Text += "<br>" + item.Value + "/" + item.Text;
            		}
            	}
            </script>
            <form runat="server">
            <mbdlb:DualList runat="server" Id="DualList1" OnItemsMoved="DualList1_ItemsMoved" >
            	<LeftItems>
            		<asp:ListItem Value="1" Text="One" />
            		<asp:ListItem Value="2" Text="Two" />
            		<asp:ListItem Value="3" Text="Three" />
            	</LeftItems>
            	<RightItems>
            		<asp:ListItem Value="4" Text="Four" />
            		<asp:ListItem Value="5" Text="Five" />
            		<asp:ListItem Value="6" Text="Six" />
            	</RightItems>
            </mbdlb:DualList>
            <br><br><asp:Label runat="server" id="DualResult" />
            <hr><asp:Button runat="server" text="Smack"/>
            </form>
            ]]></code>
            </example>
        </member>
        <member name="M:MetaBuilders.WebControls.DualList.CreateChildControls">
            <summary>
            Overrides <see cref="M:System.Web.UI.Control.CreateChildControls"/> to implement the Composite Control Pattern
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DualList.OnItemsMoved(System.EventArgs)">
            <summary>
            Raises the <see cref="E:MetaBuilders.WebControls.DualList.ItemsMoved"/> event.
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DualList.InitializeComponent">
            <summary>
            Initializes the contained controls.
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DualList.DataBind">
            <summary>
            Overrides <see cref="M:System.Web.UI.Control.DataBind"/>.
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DualList.FixAvailableItems">
            <summary>
            FixAvailableItems is called after <see cref="M:MetaBuilders.WebControls.DualList.DataBind"/> to make sure that none of the items on the right, "chosen", list exist in the left, "available" list.
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DualList.OnPreRender(System.EventArgs)">
            <summary>
            Overrides <see cref="M:System.Web.UI.Control.OnPreRender(System.EventArgs)"/>.
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DualList.Render(System.Web.UI.HtmlTextWriter)">
            <summary>
            Overrides <see cref="M:System.Web.UI.Control.Render(System.Web.UI.HtmlTextWriter)"/>.
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DualList.CreateControlStyle">
            <summary>
            Overrides <see cref="M:System.Web.UI.WebControls.WebControl.CreateControlStyle"/>.
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DualList.RegisterScript">
            <summary>
            Registers the script for this control.
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DualList.RegisterScriptLibrary">
            <summary>
            Registers the script library for this control.
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DualList.RegisterScriptArray">
            <summary>
            Registers the script array for this control.
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DualList.RegisterScriptStartup">
            <summary>
            Registers the script which initializes this control.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DualList.Controls">
            <summary>
            Overrides <see cref="P:System.Web.UI.Control.Controls"/> to implement the Composite Control Pattern
            </summary>
        </member>
        <member name="E:MetaBuilders.WebControls.DualList.ItemsMoved">
            <summary>
            The event that fires when items have been moved.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DualList.TagKey">
            <summary>
            Overrides <see cref="P:System.Web.UI.WebControls.WebControl.TagKey"/>
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DualList.LeftDataSource">
            <summary>
            Gets or sets the DataSource of the list on the left side of the control.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DualList.LeftDataMember">
            <summary>
            Gets or sets the DataMember of the list on the left side of the control.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DualList.LeftDataTextField">
            <summary>
            Gets or sets the DataTextField of the list on the left side of the control.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DualList.LeftDataValueField">
            <summary>
            Gets or sets the DataValueField of the list on the left side of the control.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DualList.LeftDataTextFormatString">
            <summary>
            Gets or sets the DataTextFormatString of the list on the left side of the control.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DualList.LeftItems">
            <summary>
            Gets the items in the list the left side of the control.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DualList.LeftListStyle">
            <summary>
            Gets the <see cref="P:System.Web.UI.WebControls.WebControl.ControlStyle"/> of the list on left side of the control.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DualList.RightDataSource">
            <summary>
            Gets or sets the DataSource of the list on the right side of the control.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DualList.RightDataMember">
            <summary>
            Gets or sets the DataMember of the list on the right side of the control.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DualList.RightDataTextField">
            <summary>
            Gets or sets the DataTextField of the list on the right side of the control.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DualList.RightDataValueField">
            <summary>
            Gets or sets the DataValueField of the list on the right side of the control.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DualList.RightDataTextFormatString">
            <summary>
            Gets or sets the DataTextFormatString of the list on the right side of the control.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DualList.RightItems">
            <summary>
            Gets the items in the list the right side of the control.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DualList.RightListStyle">
            <summary>
            Gets the <see cref="P:System.Web.UI.WebControls.WebControl.ControlStyle"/> of the list on right side of the control.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DualList.ListRows">
            <summary>
            Gets or sets the number of rows visible in the lists of the control.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DualList.ItemsName">
            <summary>
            Gets or sets the text displayed above the lists, the plural name of the items being chosen.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DualList.EnableMoveAll">
            <summary>
            Gets or sets the visibility of the buttons for moving all items between the lists.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DualList.EnableMoveUpDown">
            <summary>