metabuilders.webcontrols.dialogwindow.xml

一个非常好的Web自定义控件

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>MetaBuilders.WebControls.DialogWindow</name>
    </assembly>
    <members>
        <member name="T:MetaBuilders.WebControls.DialogControlConverter">
            <summary>
            Gives better designer support for the DialogToOpen properties of DialogOpenButton and DialogOpenLink.
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogControlConverter.GetStandardValuesSupported(System.ComponentModel.ITypeDescriptorContext)">
            <summary>
            Makes the converter a combobox
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogControlConverter.GetStandardValuesExclusive(System.ComponentModel.ITypeDescriptorContext)">
            <summary>
            Makes the converter a combobox
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogControlConverter.GetStandardValues(System.ComponentModel.ITypeDescriptorContext)">
            <summary>
            Gets a list of all the controls that derive from DialogWindowBase.
            </summary>
        </member>
        <member name="T:MetaBuilders.WebControls.DialogDesigner">
            <summary>
            The designer for DialogWindow controls.
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogDesigner.GetDesignTimeHtml">
            <summary>
            Overrides <see cref="M:System.Web.UI.Design.ControlDesigner.GetDesignTimeHtml"/>.
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogHandlerFactory.EnsureHandlerFactory">
            <summary>
            Ensures that the IHttpHandlerFactory required for built in dialogs to function, is registered for this application.
            </summary>
        </member>
        <member name="T:MetaBuilders.WebControls.DialogImageHandler">
            <summary>
            Responds to requests by outputting the messagebox icons embedded into the assembly as resources.
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogImageHandler.ProcessRequest(System.Web.HttpContext)">
            <summary>
            Implements <see cref="M:System.Web.IHttpHandler.ProcessRequest(System.Web.HttpContext)"/>.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DialogImageHandler.IsReusable">
            <summary>
            Implements <see cref="P:System.Web.IHttpHandler.IsReusable"/>.
            </summary>
        </member>
        <member name="T:MetaBuilders.WebControls.DialogInputBox">
            <summary>
            Provides an interface similar to the VB InputBox.
            Call <see cref="M:MetaBuilders.WebControls.DialogWindowBase.Open"/> to display the inputbox dialog window, or point a <see cref="T:MetaBuilders.WebControls.DialogOpenButton"/> at it.
            </summary>
            <remarks>
            <p>The DialogInputBox control requires a custom httpHandler setting in the application web.config file. To do this, add the following line to the httpHandlers section of your web.config file</p>
            <code>
            &lt;add verb="*" 
            path="MetaBuilders_DialogWindow.axd" 
            type="MetaBuilders.WebControls.DialogHandlerFactory,MetaBuilders.WebControls.DialogWindow" 
            validate="false"/&gt;</code>
            <p>
            The DialogInputBox control requires javascript support in order to function.
            </p>
            </remarks>
            <example>
            The following example shows you how to use the <see cref="T:MetaBuilders.WebControls.DialogInputBox"/> on your page.
            <code>
            <![CDATA[
            <%@ Register TagPrefix="mbdw" Namespace="MetaBuilders.WebControls" Assembly="MetaBuilders.WebControls.DialogWindow" %>
            <script runat="server" language="c#" >
            protected void MyDialogWindow_DialogClosed( Object sender, DialogResultEventArgs e ) {
            	Entry.Text = e.Results;
            }
            </script>
            <form runat="server">
            	<asp:TextBox runat="server" Id="Entry" />
            	<mbdw:DialogInputBox runat="server" Id="MyInputBox" 
            		OnDialogClosed="MyDialogWindow_DialogClosed" 
            		Prompt="Please Enter A Value." />
            	<mbdw:DialogOpenButton runat="server" 
            		DialogToOpen="MyInputBox" 
            		Text="Open An Input Box" />
            </form>
            ]]>
            </code>
            </example>
        </member>
        <member name="T:MetaBuilders.WebControls.DialogWindowBase">
            <summary>
            Controls that represent a dialog window derive from this class.
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogWindowBase.OnDialogClosed(MetaBuilders.WebControls.DialogResultEventArgs)">
            <summary>
            Raises the DialogClosed event.
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogWindowBase.OnPreRender(System.EventArgs)">
            <summary>
            Overrides <see cref="M:System.Web.UI.Control.OnPreRender(System.EventArgs)"/>
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogWindowBase.RegisterClientScript">
            <summary>
            Registers the neccessary clientscript for the dialog.
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogWindowBase.GetDialogOpenScript(System.String,System.Collections.Specialized.NameValueCollection)">
            <summary>
            Gets the script neccessary to open the dialog.
            </summary>
            <remarks>
            <p>
            When deriving from this class, you generally want to implement the publi GetDialogOpenScript by calling this method with the proper url and features.
            </p>
            </remarks>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogWindowBase.GetStandardFeatures">
            <summary>
            Creates and returns a NameValueCollection which has the standard features for a dialog window.
            </summary>
            <remarks>
            This is meant for developers creating custom dialogs.
            </remarks>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogWindowBase.GetDialogOpenScript">
            <summary>
            Generates the script neccessary to open the dialog.
            </summary>
            <remarks>
            <p>Calling <see cref="M:MetaBuilders.WebControls.DialogWindowBase.Open"/> will cause this script to be sent to the client browser.</p>
            <p>This method can also be used to open the dialog on the client without postingback.</p>
            <p>This method is only public for developers who want to customize how and when the window is opened via code or a custom server control.</p>
            </remarks>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogWindowBase.Open">
            <summary>
            Opens the dialog.
            </summary>
            <remarks>
            The dialog window is opened via a script run on the client browser.
            Attach to the <see cref="E:MetaBuilders.WebControls.DialogWindowBase.DialogClosed"/> event to get the results of the dialog.
            </remarks>
        </member>
        <member name="P:MetaBuilders.WebControls.DialogWindowBase.Resizable">
            <summary>
            Gets or sets if the user can resize the window.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DialogWindowBase.DefaultResultValue">
            <summary>
            Gets or sets the result returned and used in the <see cref="E:MetaBuilders.WebControls.DialogWindowBase.DialogClosed"/> event when the dialog is closed via OS window methods such as clicking the "X" button, or by calling <see cref="M:MetaBuilders.WebControls.DialogPage.Close(System.String)"/> with no parameters.
            </summary>
        </member>
        <member name="E:MetaBuilders.WebControls.DialogWindowBase.DialogClosed">
            <summary>
            The event that is raised when the user has closed the dialog and results have been returned.
            </summary>
            <remarks>
            This event is not raised when no results are returned or the user closes the dialogwindow via the native window closing mechanisms.
            
            </remarks>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogInputBox.GetDialogOpenScript">
            <summary>
            Generates the script neccessary to open the current inputbox.
            </summary>
            <remarks>
            <p>Calling <see cref="M:MetaBuilders.WebControls.DialogWindowBase.Open"/> will cause this script to be sent to the client browser.</p>
            <p>This method can also be used to open the inputbox on the client without postingback.</p>
            <p>This method is only public for developers who want to customize how and when the window is opened via code or a custom server control.</p>
            </remarks>
        </member>
        <member name="P:MetaBuilders.WebControls.DialogInputBox.Prompt">
            <summary>
            Gets or sets the prompt text of the inputbox.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DialogInputBox.DefaultText">
            <summary>
            Gets or sets the text initially filled in the textbox.
            </summary>
        </member>
        <member name="P:MetaBuilders.WebControls.DialogInputBox.Title">
            <summary>
            Gets or sets the title of the inputbox window.
            </summary>
        </member>
        <member name="T:MetaBuilders.WebControls.DialogInputBoxPage">
            <summary>
            This is the page which provides the UI for the <see cref="T:MetaBuilders.WebControls.DialogInputBox"/>.
            </summary>
        </member>
        <member name="T:MetaBuilders.WebControls.DialogPage">
            <summary>
            DialogPage is the base class for pages which are functioning as dialogs.
            </summary>
            <remarks>
            When using the <see cref="T:MetaBuilders.WebControls.DialogWindow"/> control, 
            the <see cref="P:MetaBuilders.WebControls.DialogWindow.TargetUrl"/> should point to a page which derives,
            directly or indirectly, from <see cref="T:MetaBuilders.WebControls.DialogPage"/>.
            </remarks>
            <example>
            The following example shows you a typical <see cref="T:MetaBuilders.WebControls.DialogPage"/>.
            <code>
            <![CDATA[
            <%@ Page Language="C#" Inherits="MetaBuilders.WebControls.DialogPage"  %>
            <script runat="server">
            protected void Smack_Click(Object sender, EventArgs e ) {
            	this.Close(Results.Text);
            }
            </script>
            <html><body><form runat="server">
            	<asp:TextBox runat="server" Id="Results" />
            	<asp:Button runat="server" Id="Smack" Text="Smack" OnClick="Smack_Click" />
            </form></body></html>
            ]]>
            </code>
            </example>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogPage.OnPreRender(System.EventArgs)">
            <summary>
            Overrides <see cref="M:System.Web.UI.Control.OnPreRender(System.EventArgs)"/>
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogPage.RegisterScript">
            <summary>
            Registers the neccessary script for the dialog to function.
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogPage.GetDialogCloseScript(System.String)">
            <summary>
            Gets the script required to close the dialog with the given results.
            </summary>
            <remarks>
            Simply call <see cref="M:MetaBuilders.WebControls.DialogPage.Close(System.String)"/> to close the dialog from the server code.
            Only call this method to get the script neccessary to close the dialog from a client script event handler.
            </remarks>
            <param name="results">The results which will be available in the <see cref="E:MetaBuilders.WebControls.DialogWindowBase.DialogClosed"/> event.</param>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogPage.GetDialogCloseScript">
            <summary>
            Gets the script required to close the dialog with default results.
            </summary>
            <remarks>
            Simply call <see cref="M:MetaBuilders.WebControls.DialogPage.Close(System.String)"/> to close the dialog from the server code.
            Only call this method to get the script neccessary to close the dialog from a client script event handler.
            </remarks>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogPage.Close(System.String)">
            <summary>
            Closes the dialog, and returns the given results for the <see cref="E:MetaBuilders.WebControls.DialogWindowBase.DialogClosed"/> event.
            </summary>
            <param name="results">The results which will be available in the <see cref="E:MetaBuilders.WebControls.DialogWindowBase.DialogClosed"/> event.</param>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogPage.Close">
            <summary>
            Closes the dialog, and returns the default results.
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogInputBoxPage.OnInit(System.EventArgs)">
            <summary>
            Overrides <see cref="M:System.Web.UI.Control.OnInit(System.EventArgs)"/>
            </summary>
        </member>
        <member name="M:MetaBuilders.WebControls.DialogInputBoxPage.InitializeComponent">
            <summary>
            Creates the page's control tree via code instead of parsing an aspx.
            </summary>
        </member>
        <member name="T:MetaBuilders.WebControls.DialogMessageBox">
            <summary>
            Provides an interface similar to the Windows.Forms.MessageBox.
            Call <see cref="M:MetaBuilders.WebControls.DialogWindowBase.Open"/> to display the MessageBox dialog window, or point a <see cref="T:MetaBuilders.WebControls.DialogOpenButton"/> at it.
            </summary>
            <remarks>
            <p>The DialogMessageBox control requires a custom httpHandler setting in the application web.config file. To do this, add the following line to the httpHandlers section of your web.config file</p>
            <code>
            &lt;add verb="*" 
            path="MetaBuilders_DialogWindow.axd" 
            type="MetaBuilders.WebControls.DialogHandlerFactory,MetaBuilders.WebControls.DialogWindow" 
            validate="false"/&gt;</code>
            <p>
            The DialogMessageBox control requires javascript support in order to function.
            </p>
            </remarks>
            <example>
            The following example shows you how to use the <see cref="T:MetaBuilders.WebControls.DialogMessageBox"/> on your page.
            <code>
            <![CDATA[
            <%@ Register TagPrefix="mbdw" Namespace="MetaBuilders.WebControls" Assembly="MetaBuilders.WebControls.DialogWindow" %>
            <script runat="server" language="c#" >
            protected void MyDialogWindow_DialogClosed( Object sender, DialogResultEventArgs e ) {