From 175a102ddceae2ebd1a4e03916a23adafc35bda5 Mon Sep 17 00:00:00 2001
From: Tim Graham <timograham@gmail.com>
Date: Thu, 6 Jun 2013 14:15:26 -0400
Subject: Fixed #20567 - Documented BoundField.id_for_label.

Thanks littlepig for the suggestion.
---
 docs/ref/forms/api.txt | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)

(limited to 'docs/ref/forms/api.txt')

diff --git a/docs/ref/forms/api.txt b/docs/ref/forms/api.txt
index 67e3aab712..c05430c64e 100644
--- a/docs/ref/forms/api.txt
+++ b/docs/ref/forms/api.txt
@@ -688,6 +688,29 @@ by a ``Widget``::
     >>> print(bound_form['subject'].value())
     hi
 
+.. attribute:: BoundField.id_for_label
+
+Use this property to render the ID of this field. For example, if you are
+manually constructing a ``<label>`` in your template (despite the fact that
+:meth:`~BoundField.label_tag` will do this for you):
+
+.. code-block:: html+django
+
+    <label for="{{ form.my_field.id_for_label }}">...</label>{{ my_field }}
+
+By default, this will be the field's name prefixed by ``id_``
+("``id_my_field``" for the example above). You may modify the ID by setting
+:attr:`~django.forms.Widget.attrs` on the field's widget. For example,
+declaring a field like this::
+
+    my_field = forms.CharField(widget=forms.TextInput(attrs={'id': 'myFIELD'}))
+
+and using the template above, would render something like:
+
+.. code-block:: html
+
+    <label for="myFIELD">...</label><input id="myFIELD" type="text" name="my_field" />
+
 .. _binding-uploaded-files:
 
 Binding uploaded files to a form
-- 
cgit v1.3