docs/manual/tasks/urlencode.html


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
  <head>
    <title>Ant-contrib Tasks: URLEncode</title>
  </head>

  <body>
    <h1>Foreach</h1>

    <p>The URLEncode task will encode a given property for use within a
    a URL string.   This value which is actually set will be encoded
    via the <code>java.net.URLEncoder.encode()</code> method.
    Typically, you must do this for all parameter values within a URL.</p>

    <h2>Parameters</h2>
    <table border="1" cellpadding="2" cellspacing="0">
      <tr>
        <th>Attribute</th>
        <th>Description</th>
        <th>Required</th>
      </tr>
      <tr>
        <td valign="top">property</td>
        <td valign="top">The name of the property to set.</td>
        <td align="center" valign="top">Yes.</td>
      </tr>
      <tr>
        <td valign="top">override</td>
        <td valign="top">If the property is already set, should we change it's value.
            Can be <code>true</code> or <code>false</code></td>
        <td align="center" valign="top">No. Defaults to <code>false</code></td>
      </tr>
      <tr>
        <td valign="top">name <i>Deprecated</i></td>
        <td valign="top">The name of the property to set.</td>
        <td align="center" valign="top">No.  Use the <code>property</code> attribute
            instead</td>
      </tr>
      <tr>
        <td valign="top">value</td>
        <td valign="top">The value of the property.</td>
        <td align="center" valign="top">No, if refid or location is specified</td>
      </tr>
      <tr>
        <td valign="top">location</td>
        <td valign="top">The location of a file whose absolute path will be the value
        of the property.</td>
        <td align="center" valign="top">No, if value or refid is specified.</td>
      </tr>
      <tr>
        <td valign="top">refid</td>
        <td valign="top">The id of a saved reference whose value will be the value
        of the property.</td>
        <td align="center" valign="top">No, defaults to &quot;,&quot;.</td>
      </tr>
    </table>


    <h2>Example</h2>


    The following code

    <pre>
    <code>
    &lt;urlencode name="file.location" location="C:\\wwwhome\\my reports\\report.xml" /&gt;
    </code>
    </pre>

    would set the "file.location" property to the value: <code> C%3A%5Cwwwhome%5Cmy+reports%5Creport.xml</code>
    which could then be used in a URL.

    <hr>
    <p align="center">Copyright &copy; 2002-2003 Ant-Contrib Project. All
    rights Reserved.</p>

  </body>
</html>