From: Argiris K. <be...@us...> - 2005-11-27 17:30:20
|
Update of /cvsroot/magicajax/magicajax/Docs In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv8325/Docs Modified Files: Configuration.html Features.html Integration.html Readme.html Usage.html Added Files: Limitations.html Log Message: Finished the Docs stuff. --- NEW FILE: Limitations.html --- <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> <html> <head> <title>MagicAjax.NET Limitations</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <style type="text/css"> <!-- .MainHeader { font-weight: bold; color: white; background-color: #0066cc; font-size: 10pt} body { font-family: Verdana, Arial, Helvetica, sans-serif; font-size: 10pt; color: black; background-color: white} .BorderHeader { background-color: #999900; font-size: 8pt; font-weight: bold; color: #333300; text-align: center} .MainContent { font-family: Verdana, Arial, Helvetica, sans-serif; font-size: 10pt; color: black } .BorderContent { font-size: 8pt; color: black; border-color: black #666600 #666600; padding-top: 2px; padding-right: 2px; padding-bottom: 10px; padding-left: 2px; margin-bottom: 2px; border-style: solid; border-top-width: 0px; border-right-width: 1px; border-bottom-width: 1px; border-left-width: 1px} a:link { color: #000099; text-decoration: underline} a:hover { color: #000099; text-decoration: underline} a:visited { color: #000099; text-decoration: underline} li { color: black; list-style-type: circle; position: relative; left: -15px; clip: rect( )} .NewsDate { color: black; font-weight: bold} td { font-size: 10pt} th { font-size: 10pt} .Annotation { font-size: 10px} H1 { text-align: center; } A.qindex {} A.qindexRef {} A.el { text-decoration: none; font-weight: bold } A.elRef { font-weight: bold } A.code { text-decoration: none; font-weight: normal; color: #4444ee } A.codeRef { font-weight: normal; color: #4444ee } DL.el { margin-left: -1cm } DIV.fragment { width: 100%; border: none; background-color: #003300 } DIV.ah { background-color: black; margin-bottom: 3; margin-top: 3 } TD.md { background-color: #006600 } DIV.groupHeader { margin-left: 16; margin-top: 12; margin-bottom: 6; font-weight: bold } DIV.groupText { margin-left: 16; font-style: italic; font-size: smaller } FONT.keyword { color: #008000 } FONT.keywordtype { color: #999920 } FONT.keywordflow { color: #e0FF00 } FONT.comment { color: #009900 } FONT.preprocessor { color: #809020 } FONT.stringliteral { color: #002080 } FONT.charliteral { color: #008080 } H3 { FONT-FAMILY: trebuchet ms,helvetica,arial } .ex { FONT-SIZE: 8pt; FONT-FAMILY: tahoma } CODE.keywordtype { COLOR: #00ccff } CODE.keyword { FONT-WEIGHT: bold; COLOR: #00ccff } CODE.fn { COLOR: white; FONT-WEIGHT: bold; } CODE.var { COLOR: #dcdcdc; } CODE.macro { COLOR: #809020; FONT-WEIGHT: bold; } CODE.comm { COLOR: lime } CODE.num { COLOR: purple } CODE.str { COLOR: #ffcc33; font-style: italic } .SectionHeader { font-size: 14px; color: #FFFFCC; font-weight: bold} .header { font-size: 16px; font-weight: bold; color: #663399} --></style> </head> <body text="#000000" bgColor="#ffffff"> <p class="header" align="center">MagicAjax.NET Framework</p> <P class="header" align="center">Limitations</P> <p class="MainHeader" align="left">MagicAjax Limitations</p> <p class="MainContent"> These are the currently known limitations of MagicAjax v0.2.:</p> <p class="MainContent"> <UL> <LI> Only IE and Firefox browsers are supported. MagicAjax will be disabled for other browsers and the page will work with plain PostBacks <li> For the <a href="Configuration.html#mode">NoStore PageStore mode</a>, if the tag attributes (CssClass, BackColor, etc.) of an AjaxPanel change during an AjaxCall, the changes will not be reflected to the client's browser </li> </UL> <P></P> <p class="NewsDate">.NET 2.0 Limitations</p> <p class="MainContent"> <ul> <LI> 'Server.Transfer' method call during an AjaxCall is not handled properly <li> <a href="Configuration.html#mode">Session/Cache PageStore modes</a> are not supported </li> </ul> <P></P> <P class="MainHeader" align="left"> </P> <P>Copyright © 2005 by The MagicAjax.NET Team</P> </body> </html> Index: Configuration.html =================================================================== RCS file: /cvsroot/magicajax/magicajax/Docs/Configuration.html,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** Configuration.html 26 Nov 2005 14:50:54 -0000 1.1 --- Configuration.html 27 Nov 2005 17:30:00 -0000 1.2 *************** *** 2,6 **** <html> <head> ! <title>MagicAjax.NET Readme</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <style type="text/css"> <!-- .MainHeader { font-weight: bold; color: white; background-color: #0066cc; font-size: 10pt} --- 2,6 ---- <html> <head> ! <title>MagicAjax.NET Configuration</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <style type="text/css"> <!-- .MainHeader { font-weight: bold; color: white; background-color: #0066cc; font-size: 10pt} *************** *** 157,166 **** <hr> <P></P> ! <p class="NewsDate">OutputCompareMode</p> <p class="MainContent"><b>Type:</b> enumeration (HashCode / MD5 / FullHtml)<br> <b>Default:</b> HashCode<br> <b>Description:</b> ! When an AjaxCall is invoked, MagicAjax compares the previous html rendering of ! controls included in an AjaxPanel with the current one, to see if changes occured. Instead of keeping the complete html string, MagicAjax produces 'fingerprints' of the html rendering strings to compare them. When --- 157,166 ---- <hr> <P></P> ! <p class="NewsDate"><a name="OutputCompareMode"></a>OutputCompareMode</p> <p class="MainContent"><b>Type:</b> enumeration (HashCode / MD5 / FullHtml)<br> <b>Default:</b> HashCode<br> <b>Description:</b> ! When an AjaxCall is invoked, MagicAjax compares the previous html renderings of ! controls included in an AjaxPanel with the current ones, to see if changes occured. Instead of keeping the complete html string, MagicAjax produces 'fingerprints' of the html rendering strings to compare them. When Index: Usage.html =================================================================== RCS file: /cvsroot/magicajax/magicajax/Docs/Usage.html,v retrieving revision 1.1 retrieving revision 1.2 diff -C2 -d -r1.1 -r1.2 *** Usage.html 25 Nov 2005 00:04:50 -0000 1.1 --- Usage.html 27 Nov 2005 17:30:00 -0000 1.2 *************** *** 2,6 **** <html> <head> ! <title>MagicAjax.NET Readme</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <style type="text/css"> <!-- .MainHeader { font-weight: bold; color: white; background-color: #0066cc; font-size: 10pt} --- 2,6 ---- <html> <head> ! <title>MagicAjax.NET Usage</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <style type="text/css"> <!-- .MainHeader { font-weight: bold; color: white; background-color: #0066cc; font-size: 10pt} *************** *** 13,17 **** a:visited { color: #000099; text-decoration: underline} li { color: black; list-style-type: circle; position: relative; left: -15px; clip: rect( )} ! .NewsDate { color: black; font-weight: bold} td { font-size: 10pt} th { font-size: 10pt} --- 13,17 ---- a:visited { color: #000099; text-decoration: underline} li { color: black; list-style-type: circle; position: relative; left: -15px; clip: rect( )} ! .NewsDate { color: black; font-weight: bold; font-size: 11pt} td { font-size: 10pt} th { font-size: 10pt} *************** *** 57,80 **** <UL> <LI> ! <a href="#ajaxpanel">AjaxPanel</a> ! <LI> ! <a href="#AjaxHtml">AjaxHtmlAnchor and AjaxHtmlImage</a> ! <LI> ! <a href="#AjaxPage">AjaxPage and AjaxUserControl</a> ! <LI> ! <a href="#attributes">Additional attributes for ASP.NET controls</a> ! </LI> </UL> ! <p class="MainHeader" align="left">MagicAjax Usage</p> <p class="NewsDate"><a name="ajaxpanel"></a>AjaxPanel</p> ! <p class="MainContent"> ! This is the core control of the MagicAjax framework. For all the controls that ! are inside an AjaxPanel, their PostBack functionality is replaced by an AJAX ! callback (AjaxCall), unless defined otherwise. </p> ! <P class="MainContent">Its <i>AjaxCallConnection </i>property can be set to: <ul> <li> ! Asynchronous <ul> The AjaxCall will be invoked in the background --- 57,120 ---- <UL> <LI> ! Programming ! <ul> ! <li> ! <A href="#ajaxcall">Handling an AjaxCall</A> ! </li> ! </ul> ! <li> ! Controls ! <ul> ! <LI> ! <A href="#ajaxpanel">AjaxPanel</A> ! <LI> ! <A href="#AjaxHtml">AjaxHtmlAnchor and AjaxHtmlImage</A> ! <LI> ! <A href="#AjaxPage">AjaxPage and AjaxUserControl</A> ! <LI> ! <A href="#attributes">MagicAjax attributes for ASP.NET controls</A> ! </LI> ! </ul> ! </li> </UL> ! <p class="MainHeader" align="left">Programming</p> ! <p class="NewsDate"><a name="ajaxcall"></a>Handling an AjaxCall</p> ! <p class="MainContent">Depending on the PageStore Mode configuration option, the ! page's execution cycle will differ significantly (see <A href="Configuration.html#Mode"> ! Configuration Options</A>). For the default 'NoStore' mode, the page's ! execution cycle will be the same as a PostBack. You can distinguish if a ! PostBack or an AjaxCall occured, by checking the return value of the <b>MagicAjaxContext.Current.IsAjaxCallForPage</b> ! method. ! </p> ! <P class="MainContent"><b>Note:</b> There is a <b>MagicAjaxContext.Current.IsAjaxCall</b> ! property that is true if the http request was originated by an AjaxCall, but ! the recommended method of checking whether an AjaxCall was invoked is by using <b>IsAjaxCallForPage</b>. ! If the page is created because of a <i>Server.Transfer</i> call that occured ! during an AjaxCall, IsAjaxCallForPage will return false so that your page can ! execute as a normal page request. The <b>AjaxPage.IsAjaxCall</b> property, ! that makes a call to IsAjaxCallForPage, is provided for convenience (see <A href="#AjaxPage"> ! AjaxPage</A>).</P> ! <P class="MainContent">MagicAjax sends javascript code to the client as a response ! to an AjaxCall. If you want to send your custom javascript along with ! MagicAjax's, you can use the static functions of <b>AjaxCallHelper</b>. ! For example: ! <pre> private void Button1_Click(object sender, System.EventArgs e) ! { ! AjaxCallHelper.WriteAlert ("Button1 was clicked."); ! }</pre> ! <P></P> ! <p class="MainHeader" align="left">Controls</p> <p class="NewsDate"><a name="ajaxpanel"></a>AjaxPanel</p> ! <p class="MainContent">This is the core control of the MagicAjax framework. The ! PostBack functionality of all the controls that are inside an AjaxPanel will be ! replaced by an AJAX callback (AjaxCall), unless defined otherwise. AjaxPanel ! works like the ASP.NET Panel, its contents are visible on the designer, you ! can set all the WebControl attributes to it, change its Visible property ! etc. </p> ! <P class="MainContent">Its <b>AjaxCallConnection </b>property can be set to: <ul> <li> ! Asynchronous (Default) <ul> The AjaxCall will be invoked in the background *************** *** 93,113 **** </ul> <P></P> ! <P class="MainContent">AjaxPanel works like the ASP.NET Panel, its contents are ! visible on the designer, you can add all the WebControl attributes to it, ! change its Visible property etc.</P> ! <P class="MainContent">AjaxPanel checks its</P> <p class="NewsDate"><a name="AjaxHtml"></a>AjaxHtmlAnchor and AjaxHtmlImage</p> ! <p class="MainContent"> ! It is recommended ! </p> <p class="NewsDate"><a name="AjaxPage"></a>AjaxPage and AjaxUserControl</p> ! <p class="MainContent"> ! It is recommended ! </p> ! <p class="NewsDate"><a name="attributes"></a>Additional attributes for ASP.NET controls</p> ! <p class="MainContent"> ! It is recommended </p> <P class="MainHeader" align="left"> </P> <P>Copyright © 2005 by The MagicAjax.NET Team</P> --- 133,217 ---- </ul> <P></P> ! <P class="MainContent">In order to reduce the amount of html needed to send to ! client, AjaxPanel defines individual 'html holders'. If the html ! of a holder changes during an AjaxCall, MagicAjax sends the whole ! html of the holder so that it can be reflected to the client's browser. ! Every immediate WebControl child of an AjaxPanel is considered a separate ! holder, and one extra holder is defined for the literal and HtmlControls ! content of the AjaxPanel. Thus, if the html of a WebControl, that is ! enclosed inside an AjaxPanel, changes, only the html of the particular ! WebControl will be sent to the client.</P> ! <P class="MainContent">An AjaxPanel (child AjaxPanel) that is inside ! another AjaxPanel (parent AjaxPanel), define its html holders separately from ! its parent. The parent AjaxPanel will ignore the html of the child AjaxPanel; ! only the child AjaxPanel will be responsible for reflecting its holders on the ! client. Thus, you can reduce the traffic of AjaxCalls, by adding many ! AjaxPanels that define more and smaller html holders. For example, if you put a ! table inside an AjaxPanel and change one of its cells during an AjaxCall, the ! complete html of the table is going to be sent to the client. On the other ! hand, if you add an AjaxPanel for each cell, only the html of the contents of ! the changed cell will be sent to the client.</P> ! <P class="MainContent">In order to monitor the traffic of AjaxCalls that your page ! is producing, you can enable the <A href="Configuration.html#tracing">tracing</A> configuration ! option.</P> ! <P class="MainContent"> ! <hr> ! <P></P> ! <P></P> <p class="NewsDate"><a name="AjaxHtml"></a>AjaxHtmlAnchor and AjaxHtmlImage</p> ! <p class="MainContent">These controls are intented to be used only for the <A href="Configuration.html#Mode"> ! Session/Cache PageStore modes</A>. When these modes are selected, ASP.NET's ! HtmlAnchor and HtmlImage loose their <i>href</i> and <i>src</i> attributes ! during an AjaxCall. AjaxHtmlAnchor and AjaxHtmlImage can be used in their ! place. ! <hr> ! <P></P> <p class="NewsDate"><a name="AjaxPage"></a>AjaxPage and AjaxUserControl</p> ! <p class="MainContent">Making your pages and usercontrols inherit from AjaxPage and ! AjaxUserControl is not required; they're provided only for convenience. They ! expose the MagicAjax's stored page events (see <A href="Configuration.html#Mode">Session/Cache ! PageStore modes</A>) and provide the <b>IsAjaxCall</b> property that makes ! a call to MagicAjaxContext.Current.IsAjaxCallForPage. ! <hr> ! <P></P> ! <p class="NewsDate"><a name="attributes"></a>MagicAjax attributes for ASP.NET controls</p> ! <p class="MainContent">You can add special attributes to ASP.NET controls that ! define how they will be handled by MagicAjax: ! <ul> ! <li> ! <b>AjaxCall</b> ("Async" or "Sync" or "None") ! <p>If you add the <i>AjaxCall</i> attribute with "Async"/"Sync" value to a control ! that has PostBack functionality (i.e. Button, LinkButton, CheckBox, etc.) the ! PostBack functionality of the control will be replaced by AJAX functionality, ! even if it is not contained inside an AjaxPanel. If you add the <i>AjaxCall</i> ! attribute with "None" value to a control that is inside an AjaxPanel, the ! control will perform a PostBack instead of an AjaxCall. By adding the <i>AjaxCall</i> ! attribute, you override the AjaxCallConnection property of its parent AjaxPanel ! (if the AjaxPanel is set to Asynchronous, you can add <i>AjaxCall</i> with ! "sync" value to a control to make it perform a synchronous AjaxCall). The ! effect of the <i>AjaxCall</i> attribute is applied to all the children of the ! control, so if you add it to a plain ASP.NET Panel, all the controls that are ! contained inside this Panel will get the effect of the <i>AjaxCall</i> attribute. ! </p> ! <li> ! <b>ExcludeFromPost</b> ("true" or "false") ! <p>When an AjaxCall is invoked, the client sends the values of the form elements to ! the server as POST data. If there is a control that is used only to display ! information and not to get input from the user, you can add the <i>ExcludeFromPost</i> ! attribute with "true" value and the value of this control will not be sent ! to the server. For example, if your page contains a readonly TextBox that is ! used to display chat messages, sending its contents for every AjaxCall is ! unnecessary traffic; you can avoid it by using the <i>ExcludeFromPost</i> attribute.</p> ! </li> ! </ul> ! <P></P> ! <p>All the attributes can be added using the visual designer or by code. Their ! values, and consequently their function, can be changed during an AjaxCall. </p> + <p>Example: + <pre> Button1.Attributes["ajaxcall"] = "async";</pre> + <hr> + <P></P> <P class="MainHeader" align="left"> </P> <P>Copyright © 2005 by The MagicAjax.NET Team</P> Index: Readme.html =================================================================== RCS file: /cvsroot/magicajax/magicajax/Docs/Readme.html,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** Readme.html 26 Nov 2005 14:50:54 -0000 1.2 --- Readme.html 27 Nov 2005 17:30:00 -0000 1.3 *************** *** 57,61 **** <p>MagicAjax.NET is a framework written in C# that provides AJAX technologies for web pages created with ASP.NET. It is designed to make it easier and more ! intuitive for developers to integrate AJAX support into their pages without replacing the ASP.NET controls and/or writing javascript code. </p> --- 57,61 ---- <p>MagicAjax.NET is a framework written in C# that provides AJAX technologies for web pages created with ASP.NET. It is designed to make it easier and more ! intuitive for developers to integrate AJAX support into their pages, without replacing the ASP.NET controls and/or writing javascript code. </p> Index: Integration.html =================================================================== RCS file: /cvsroot/magicajax/magicajax/Docs/Integration.html,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** Integration.html 26 Nov 2005 14:50:54 -0000 1.2 --- Integration.html 27 Nov 2005 17:30:00 -0000 1.3 *************** *** 2,6 **** <html> <head> ! <title>MagicAjax.NET Readme</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <style type="text/css"> <!-- .MainHeader { font-weight: bold; color: white; background-color: #0066cc; font-size: 10pt} --- 2,6 ---- <html> <head> ! <title>MagicAjax.NET Integration</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <style type="text/css"> <!-- .MainHeader { font-weight: bold; color: white; background-color: #0066cc; font-size: 10pt} *************** *** 57,62 **** <p class="NewsDate">Modifying web.config</p> <p class="MainContent"> ! The MagicAjaxModule should be registered in the web.config file of your ! application, like this: <pre> <httpModules> --- 57,62 ---- <p class="NewsDate">Modifying web.config</p> <p class="MainContent"> ! The MagicAjaxModule should be registered in the <i>system.web</i> section of ! the web.config file of your application, like this: <pre> <httpModules> Index: Features.html =================================================================== RCS file: /cvsroot/magicajax/magicajax/Docs/Features.html,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** Features.html 26 Nov 2005 14:50:54 -0000 1.2 --- Features.html 27 Nov 2005 17:30:00 -0000 1.3 *************** *** 2,6 **** <html> <head> ! <title>MagicAjax.NET Readme</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <style type="text/css"> <!-- .MainHeader { font-weight: bold; color: white; background-color: #0066cc; font-size: 10pt} --- 2,6 ---- <html> <head> ! <title>MagicAjax.NET Features</title> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> <style type="text/css"> <!-- .MainHeader { font-weight: bold; color: white; background-color: #0066cc; font-size: 10pt} |