1
<?xml version="1.0"?>
2<doc>
3 <assembly>
4 <name>IFNuke.WebUtility</name>
5 </assembly>
6 <members>
7 <member name="M:IFNuke.UI.Utilities.Globals.FindControlRecursive(System.Web.UI.Control,System.String)">
8 -----------------------------------------------------------------------------
9 <summary>
10 Searches control hierarchy from top down to find a control matching the passed in name
11 </summary>
12 <param name="objParent">Root control to begin searching</param>
13 <param name="strControlName">Name of control to look for</param>
14 <returns></returns>
15 <remarks>
16 This differs from FindControlRecursive in that it looks down the control hierarchy, whereas, the
17 FindControlRecursive starts at the passed in control and walks the tree up. Therefore, this function is
18 more a expensive task.
19 </remarks>
20 </member>
21 <member name="T:IFNuke.UI.Utilities.ClientAPI">
22 -----------------------------------------------------------------------------
23 Project : IFNuke
24 Class : ClientAPI
25 -----------------------------------------------------------------------------
26 <summary>
27 Library responsible for interacting with DNN Client API.
28 </summary>
29 <remarks>
30 </remarks>
31 <history>
32 [Jon Henning] 8/3/2004 Created
33 </history>
34 -----------------------------------------------------------------------------
35 </member>
36 <member name="F:IFNuke.UI.Utilities.ClientAPI.m_sScriptPath">
37 -----------------------------------------------------------------------------
38 <summary>Private variable holding location of client side js files. Shared by entire application.</summary>
39 -----------------------------------------------------------------------------
40 </member>
41 <member name="M:IFNuke.UI.Utilities.ClientAPI.ClientVariableControl(System.Web.UI.Page)">
42 -----------------------------------------------------------------------------
43 <summary>
44 Finds __dnnVariable control on page, if not found it attempts to add its own.
45 </summary>
46 <param name="objPage">Current page rendering content</param>
47 <value></value>
48 <remarks>
49 </remarks>
50 <history>
51 [Jon Henning] 8/3/2004 Created
52 </history>
53 -----------------------------------------------------------------------------
54 </member>
55 <member name="M:IFNuke.UI.Utilities.ClientAPI.FindForm(System.Web.UI.Control)">
56 -----------------------------------------------------------------------------
57 <summary>
58 Loop up parent controls to find form
59 </summary>
60 <remarks>
61 </remarks>
62 <history>
63 [Jon Henning] 2/2/2006 Commented
64 </history>
65 -----------------------------------------------------------------------------
66 </member>
67 <member name="M:IFNuke.UI.Utilities.ClientAPI.GetDNNVariableControl(System.Web.UI.Control)">
68 -----------------------------------------------------------------------------
69 <summary>
70 Returns __dnnVariable control if present
71 </summary>
72 <remarks>
73 </remarks>
74 <history>
75 [Jon Henning] 4/6/2005 Commented
76 </history>
77 -----------------------------------------------------------------------------
78 </member>
79 <member name="M:IFNuke.UI.Utilities.ClientAPI.GetClientVariableNameValuePair(System.Web.UI.Page,System.String)">
80 -----------------------------------------------------------------------------
81 <summary>
82 Parses DNN Variable control contents and returns out the delimited name/value pair
83 </summary>
84 <param name="objPage">Current page rendering content</param>
85 <param name="strVar">Name to retrieve</param>
86 <returns>Delimited name/value pair string</returns>
87 <remarks>
88 </remarks>
89 <history>
90 [Jon Henning] 8/3/2004 Created
91 </history>
92 -----------------------------------------------------------------------------
93 </member>
94 <member name="M:IFNuke.UI.Utilities.ClientAPI.GetKeyDownHandler(System.Int32,System.String)">
95 -----------------------------------------------------------------------------
96 <summary>
97 Returns javascript to call dnncore.js key handler logic
98 </summary>
99 <param name="intKeyAscii">ASCII value to trap</param>
100 <param name="strJavascript">Javascript to execute</param>
101 <returns>Javascript to handle key press</returns>
102 <remarks>
103 </remarks>
104 <history>
105 [Jon Henning] 2/17/2005 Created
106 </history>
107 -----------------------------------------------------------------------------
108 </member>
109 <member name="M:IFNuke.UI.Utilities.ClientAPI.AddButtonConfirm(System.Web.UI.WebControls.WebControl,System.String)">
110 -----------------------------------------------------------------------------
111 <summary>
112 Common way to handle confirmation prompts on client
113 </summary>
114 <param name="objButton">Button to trap click event</param>
115 <param name="strText">Text to display in confirmation</param>
116 <remarks>
117 </remarks>
118 <history>
119 [Jon Henning] 2/17/2005 Created
120 </history>
121 -----------------------------------------------------------------------------
122 </member>
123 <member name="M:IFNuke.UI.Utilities.ClientAPI.BrowserSupportsFunctionality(IFNuke.UI.Utilities.ClientAPI.ClientFunctionality)">
124 -----------------------------------------------------------------------------
125 <summary>
126 Determines of browser currently requesting page adaquately supports passed un client-side functionality
127 </summary>
128 <param name="eFunctionality">Desired Functionality</param>
129 <returns>True when browser supports it</returns>
130 <remarks>
131 </remarks>
132 <history>
133 [Jon Henning] 8/3/2004 Created
134 </history>
135 -----------------------------------------------------------------------------
136 </member>
137 <member name="M:IFNuke.UI.Utilities.ClientAPI.GetClientVariable(System.Web.UI.Page,System.String)">
138 -----------------------------------------------------------------------------
139 <summary>
140 Retrieves DNN Client Variable value
141 </summary>
142 <param name="objPage">Current page rendering content</param>
143 <param name="strVar">Variable name to retrieve value for</param>
144 <returns>Value of variable</returns>
145 <remarks>
146 </remarks>
147 <history>
148 [Jon Henning] 8/3/2004 Created
149 </history>
150 -----------------------------------------------------------------------------
151 </member>
152 <member name="M:IFNuke.UI.Utilities.ClientAPI.GetClientVariable(System.Web.UI.Page,System.String,System.String)">
153 -----------------------------------------------------------------------------
154 <summary>
155 Retrieves DNN Client Variable value
156 </summary>
157 <param name="objPage">Current page rendering content</param>
158 <param name="strVar">Variable name to retrieve value for</param>
159 <param name="strDefaultValue">Default value if variable not found</param>
160 <returns>Value of variable</returns>
161 <remarks>
162 </remarks>
163 <history>
164 [Jon Henning] 8/3/2004 Created
165 </history>
166 -----------------------------------------------------------------------------
167 </member>
168 <member name="M:IFNuke.UI.Utilities.ClientAPI.GetSafeJSString(System.String)">
169 -----------------------------------------------------------------------------
170 <summary>
171 Escapes string to be safely used in client side javascript.
172 </summary>
173 <param name="strString">String to escape</param>
174 <returns>Escaped string</returns>
175 <remarks>
176 Currently this only escapes out quotes and apostrophes
177 </remarks>
178 <history>
179 [Jon Henning] 2/17/2005 Created
180 </history>
181 -----------------------------------------------------------------------------
182 </member>
183 <member name="M:IFNuke.UI.Utilities.ClientAPI.NeedsDNNVariable(System.Web.UI.Control)">
184 -----------------------------------------------------------------------------
185 <summary>
186 Determines if DNNVariable control is present in page's control collection
187 </summary>
188 <remarks>
189 </remarks>
190 <history>
191 [Jon Henning] 4/6/2005 Commented
192 </history>
193 -----------------------------------------------------------------------------
194 </member>
195 <member name="M:IFNuke.UI.Utilities.ClientAPI.RegisterClientReference(System.Web.UI.Page,IFNuke.UI.Utilities.ClientAPI.ClientNamespaceReferences)">
196 -----------------------------------------------------------------------------
197 <summary>
198 Responsible for registering client side js libraries and its dependecies.
199 </summary>
200 <param name="objPage">Current page rendering content</param>
201 <param name="eRef">Enumerator of library to reference</param>
202 <remarks>
203 </remarks>
204 <history>
205 [Jon Henning] 8/3/2004 Created
206 </history>
207 -----------------------------------------------------------------------------
208 </member>
209 <member name="M:IFNuke.UI.Utilities.ClientAPI.RegisterClientVariable(System.Web.UI.Page,System.String,System.String,System.Boolean)">
210 -----------------------------------------------------------------------------
211 <summary>
212 Registers a client side variable (name/value) pair
213 </summary>
214 <param name="objPage">Current page rendering content</param>
215 <param name="strVar">Variable name</param>
216 <param name="strValue">Value</param>
217 <param name="blnOverwrite">Determins if a replace or append is applied when variable already exists</param>
218 <remarks>
219 </remarks>
220 <history>
221 [Jon Henning] 8/3/2004 Created
222 </history>
223 -----------------------------------------------------------------------------
224 </member>
225 <member name="M:IFNuke.UI.Utilities.ClientAPI.RegisterDNNVariableControl(System.Web.UI.Control)">
226 -----------------------------------------------------------------------------
227 <summary>
228 Responsible for inputting the hidden field necessary for the ClientAPI to pass variables back in forth
229 </summary>
230 <remarks>
231 </remarks>
232 <history>
233 [Jon Henning] 4/6/2005 Commented
234 </history>
235 -----------------------------------------------------------------------------
236 </member>
237 <member name="M:IFNuke.UI.Utilities.ClientAPI.RegisterKeyCapture(System.Web.UI.Control,System.Web.UI.Control,System.Int32)">
238 -----------------------------------------------------------------------------
239 <summary>
240 Traps client side keydown event looking for passed in key press (ASCII) and hooks it up with server side postback handler
241 </summary>
242 <param name="objControl">Control that should trap the keydown</param>
243 <param name="objPostbackControl">Server-side control that has its onclick event handled server-side</param>
244 <param name="intKeyAscii">ASCII value of key to trap</param>
245 <remarks>
246 </remarks>
247 <history>
248 [Jon Henning] 2/17/2005 Commented
249 </history>
250 -----------------------------------------------------------------------------
251 </member>
252 <member name="M:IFNuke.UI.Utilities.ClientAPI.RegisterKeyCapture(System.Web.UI.Control,System.String,System.Int32)">
253 -----------------------------------------------------------------------------
254 <summary>
255 Traps client side keydown event looking for passed in key press (ASCII) and hooks it up with client-side javascript
256 </summary>
257 <param name="objControl">Control that should trap the keydown</param>
258 <param name="strJavascript">Javascript to execute when event fires</param>
259 <param name="intKeyAscii">ASCII value of key to trap</param>
260 <remarks>
261 </remarks>
262 <history>
263 [Jon Henning] 2/17/2005 Commented
264 </history>
265 -----------------------------------------------------------------------------
266 </member>
267 <member name="M:IFNuke.UI.Utilities.ClientAPI.RegisterPostBackEventHandler(System.Web.UI.Control,System.String,IFNuke.UI.Utilities.ClientAPIPostBackControl.PostBackEvent,System.Boolean)">
268 -----------------------------------------------------------------------------
269 <summary>
270 Allows a listener to be associated to a client side post back
271 </summary>
272 <param name="objParent">The current control on the page or the page itself. Depending on where the page is in its lifecycle it may not be possible to add a control directly to the page object, therefore we will use the current control being rendered to append the postback control.</param>
273 <param name="strEventName">Name of the event to sync. If a page contains more than a single client side event only the events associated with the passed in name will be raised.</param>
274 <param name="objDelegate">Server side AddressOf the function to handle the event</param>
275 <param name="blnMultipleHandlers">Boolean flag to determine if multiple event handlers can be associated to an event.</param>
276 <remarks>
277 </remarks>
278 <history>
279 [Jon Henning] 9/15/2004 Created
280 </history>
281 -----------------------------------------------------------------------------
282 </member>
283 <member name="M:IFNuke.UI.Utilities.ClientAPI.EnableClientSideReorder(System.Web.UI.Control,System.Web.UI.Page,System.Boolean,System.String)">
284 -----------------------------------------------------------------------------
285 <summary>
286 Registers a button inside a table for the ability to perform client-side reordering
287 </summary>
288 <param name="objButton">Button responsible for moving the row up or down.</param>
289 <param name="objPage">Page the table belongs to. Can't just use objButton.Page because inside ItemCreated event of grid the button has no page yet.</param>
290 <param name="blnUp">Determines if the button is responsible for moving the row up or down</param>
291 <param name="strKey">Unique key for the table/grid to be used to obtain the new order on postback. Needed when calling GetClientSideReOrder</param>
292 <remarks>
293 </remarks>
294 <history>
295 [Jon Henning] 3/10/2006 Created
296 </history>
297 -----------------------------------------------------------------------------
298 </member>
299 <member name="M:IFNuke.UI.Utilities.ClientAPI.GetClientSideReorder(System.String,System.Web.UI.Page)">
300 -----------------------------------------------------------------------------
301 <summary>
302 Retrieves an array of the new order for the rows
303 </summary>
304 <param name="strKey">Unique key for the table/grid to be used to obtain the new order on postback. Needed when calling GetClientSideReOrder</param>
305 <param name="objPage">Page the table belongs to. Can't just use objButton.Page because inside ItemCreated event of grid the button has no page yet.</param>
306 <remarks>
307 </remarks>
308 <history>
309 [Jon Henning] 3/10/2006 Created
310 </history>
311 -----------------------------------------------------------------------------
312 </member>
313 <member name="P:IFNuke.UI.Utilities.ClientAPI.COLUMN_DELIMITER">
314 -----------------------------------------------------------------------------
315 <summary>Character used for delimiting name from value</summary>
316 -----------------------------------------------------------------------------
317 </member>
318 <member name="P:IFNuke.UI.Utilities.ClientAPI.CUSTOM_COLUMN_DELIMITER">
319 -----------------------------------------------------------------------------
320 <summary>Character used for delimiting name from value</summary>
321 -----------------------------------------------------------------------------
322 </member>
323 <member name="P:IFNuke.UI.Utilities.ClientAPI.CUSTOM_ROW_DELIMITER">
324 -----------------------------------------------------------------------------
325 <summary>Character used for delimiting name/value pairs</summary>
326 -----------------------------------------------------------------------------
327 </member>
328 <member name="P:IFNuke.UI.Utilities.ClientAPI.QUOTE_REPLACEMENT">
329 -----------------------------------------------------------------------------
330 <summary>In order to reduce payload, substitute out " with different char, since when put in a hidden control it uses "</summary>
331 -----------------------------------------------------------------------------
332 </member>
333 <member name="P:IFNuke.UI.Utilities.ClientAPI.ROW_DELIMITER">
334 -----------------------------------------------------------------------------
335 <summary>Character used for delimiting name/value pairs</summary>
336 -----------------------------------------------------------------------------
337 </member>
338 <member name="P:IFNuke.UI.Utilities.ClientAPI.ScriptPath">
339 -----------------------------------------------------------------------------
340 <summary>
341 Path where js files are placed
342 </summary>
343 <value></value>
344 <remarks>
345 </remarks>
346 <history>
347 [Jon Henning] 8/19/2004 Created
348 </history>
349 -----------------------------------------------------------------------------
350 </member>
351 <member name="T:IFNuke.UI.Utilities.ClientAPI.ClientNamespaceReferences">
352 -----------------------------------------------------------------------------
353 <summary>
354 Enumerates each namespace with a seperate js file
355 </summary>
356 <remarks>
357 </remarks>
358 <history>
359
IFNuke/Website/bin/DotNetNuke.WebUtility.xml，打开代码结构图