Class BoundField
A Field plus data
Declaration
@html_safe
class BoundField
source linkDocumentation
Methods
▷ def __str__(self) Render this field as an HTML widget.
▷ def as_hidden(self, attrs=None, **kwargs) Return a string of HTML for representing this as an <input type="hidden">.
▷ def as_text(self, attrs=None, **kwargs) Return a string of HTML for representing this as an <input type="text">.
▷ def as_textarea(self, attrs=None, **kwargs) Return a string of HTML for representing this as a <textarea>.
▷ def as_widget(self, widget=None, attrs=None, only_initial=False) Render the field by rendering the passed widget, adding any HTML attributes passed as attrs. If a widget isn't specified, use the field's default widget.
▷ def auto_id(self) @property Calculate and return the ID attribute for this BoundField, if the associated Form has specified auto_id. Return an empty string otherwise.
@property
def auto_id(self)
▷ def css_classes(self, extra_classes=None) Return a string of space-separated CSS classes for this field.
▷ def data(self) @property Return the data for this BoundField, or None if it wasn't given.
▷ def errors(self) @property Return an ErrorList (empty if there are no errors) for this field.
@property
def errors(self)
▷ def id_for_label(self) @property Wrapper around the field widget's `id_for_label` method. Useful, for example, for focusing on this field regardless of whether it has a single widget or a MultiWidget.
@property
def id_for_label(self)
▷ def initial(self) @cached_property @cached_property
def initial(self)
▷ def is_hidden(self) @property Return True if this BoundField's widget is hidden.
@property
def is_hidden(self)
▶ def label_tag(self, contents=None, attrs=None, label_suffix=None) Wrap the given contents in a <label>, if the field has an ID attribute. contents should be mark_safe'd to avoid HTML escaping. If contents aren't given, use the field's HTML-escaped label.
If attrs are given, use them as HTML attributes on the <label> tag.
label_suffix overrides the form's label_suffix.
▶ def subwidgets(self) @cached_property Most widgets yield a single subwidget, but others like RadioSelect and CheckboxSelectMultiple produce one subwidget for each choice.
▷ def value(self) Return the value for this BoundField, using the initial value if the form is not bound or the data otherwise.
Reexports