CMS Form

• form_redirect Boolean
  default=False form_tech=True
• form_success Boolean
  default=False form_tech=True
• form_title Char
  compute='_compute_form_title' form_tech=True

• add_status_message(self, msg, **kw)
• form_after_create_or_update(self, values, extra_values)
  Post create/update hook.
• form_before_create_or_update(self, values, extra_values)
  Pre create/update hook.
• form_cancel_url(self, main_object=None)
  URL to redirect to after click on "cancel" button.
• form_check_empty_value(self, fname, field, value, **req_values)
  Return True if passed field value is really empty.
• form_create_or_update(self)
  Prepare values and create or update main_object.
• form_get_validator(self, fname, field)
  Retrieve field validator.
• form_msg_error_missing(self)
  @property
• form_msg_success_created(self)
  @property
• form_msg_success_updated(self)
  @property
• form_next_url(self, main_object=None)
  URL to redirect to after successful form submission.
• form_process_POST(self, render_values)
  Process POST requests.
• form_validate(self, request_values=None)
  Validate submitted values.

• form_action Char
  default='' form_tech=True
• form_ajax Boolean
  default=False form_tech=True
• form_ajax_onchange Boolean
  default=False form_tech=True
• form_buttons_template Char
  default='cms_form.base_form_buttons' form_tech=True
• form_confirm_submit Boolean
  default='' form_tech=True
• form_content_selector Char
  default='.form_content' form_tech=True
• form_description Char
  default='' form_tech=True
• form_display_mode Selection
  default='horizontal' form_tech=True selection=[('horizontal', 'Horizontal'), ('vertical', 'Vertical')]
• form_extra_css_klass Char
  default='' form_tech=True
• form_extract_value_mode Selection
  default='write' form_tech=True selection=[('write', 'Write'), ('read', 'Read')]
• form_fields_template Char
  default='cms_form.base_form_fields' form_tech=True
• form_fields_wrapper_template Char
  compute='_compute_form_fields_wrapper_template' form_tech=True readonly=False
• form_fieldsets_display Selection
  default='vertical' form_tech=True selection=[('tabs', 'Tabs'), ('vertical', 'Vertical')]
• form_fname_pattern Char
  default='' form_tech=True
• form_method Char
  default='POST' form_tech=True
• form_mode Char
  compute='_compute_form_mode' default='' form_tech=True readonly=False
• form_model_name Char
  default='' form_tech=True
• form_render_values Binary
  compute='_compute_form_render_values' form_tech=True store=False
• form_template Char
  default='cms_form.base_form' form_tech=True
• form_title Char
  default='' form_tech=True
• form_wrapper_extra_css_klass Char
  default='' form_tech=True
• form_wrapper_template Char
  default='' form_tech=True
• id Id
  automatic=True
• main_object Binary
  default=None form_tech=True store=False
• o_request Binary
  form_tech=True store=False
• request Binary
  form_tech=True store=False

• fields_get(self, allfields=None, attributes=None)
  @api.model
• form_check_permission(self, raise_exception=True)
  Check permission on current model and main object if any.
• form_css_klass(self)
  @property
  Return `<form />` element css klasses. By default you can provide extra klasses via `form_extra_css_klass`.
• form_extract_values(self, **request_values)
  Extract values from request form.
• form_fields_get(self, hidden=None)
  Retrieve form fields. :param hidden: whether to include or not hidden inputs. Options: * None, default: include all fields, hidden or not * True: include only hidden fields * False: include all fields but those hidden.
• form_fieldsets_get(self)
• form_fieldsets_wrapper_klass(self)
  @property
• form_file_fields(self)
  @property
  File fields.
• form_get_current_widget(self, fname)
• form_get_extractor(self, fname, field, value=None, **req_values)
  Retrieve form value extractor. :param fname: field name :param field: field description as `fields_get` :param value: current field value if any :param req_values: custom request valuess
• form_get_field_wrapper_template(self, fname, field)
• form_get_loader(self, fname, field, main_object=None, value=None, **req_values)
  Retrieve form value loader. :param fname: field name :param field: field description as `fields_get` :param main_object: current main object if any :param value: current field value if any :param req_values: custom request valuess
• form_get_request_values(self)
  Retrieve fields values from current request.
• form_get_widget(self, fname, field, **kw)
  Retrieve and initialize widget.
• form_init(self, request, main_object=None, **kw)
  Initalize a form instance. @param request: an odoo-wrapped werkeug request @param main_object: current model instance if any @param kw: pass any override for `_form_` attributes ie: `fields_attributes` -> `form_fields_attributes`
• form_json_info(self)
• form_load_defaults(self, main_object=None, request_values=None)
  Load default values. Values lookup order: 1. `main_object` fields' values (if an existing main_object is passed) 2. request parameters (only parameters matching form fields names)
• form_make_field_wrapper_klass(self, fname, field, **kw)
  Return specific CSS klass for the field wrapper.
• form_model(self)
  @property
• form_msg_confirm_submit(self)
  @property
• form_process(self, **kw)
  Process current request. :param kw: inject custom / extra rendering values. Lookup correct request handler by request method and call it with rendering values. The handler can perform any action (like creating objects) and then return final rendering form values and store them into `form_render_values`.
• form_process_GET(self, render_values)
  Process GET requests.
• form_process_POST(self, render_values)
  Process POST requests.
• form_render(self, **kw)
  Renders form template declared in `form_template`. To render the form simply do: <t t-out="form.form_render()" />
• form_update_fields_attributes(self, _fields)
  Manipulate fields attributes.
• form_wrapper_css_klass(self)
  @property
  Return form wrapper css klass. By default the form markup is wrapped into a `cms_form_wrapper` element. You can use this set of klasses to customize form styles. Included by default: * `cms_form_wrapper` marker * form model name normalized (res.partner -> res_partner) * `form_wrapper_extra_css_klass` extra klasses from form attribute * `mode_` + form mode (ie: 'mode_write')

• form_buttons_template Char
  default='cms_form.search_form_buttons' form_tech=True
• form_extract_value_mode Char
  default='read' form_tech=True
• form_method Char
  default='GET' form_tech=True
• form_mode Char
  default='search' form_tech=True
• form_no_result_msg Char
  compute='_compute_form_no_result_msg' form_tech=True
• form_no_search_results_template Char
  default='cms_form.no_search_results' form_tech=True
• form_results_orderby Char
  default='' form_tech=True
• form_results_per_page Integer
  default=10 form_tech=True
• form_search_domain_rules Binary
  default={} form_tech=True store=False
• form_search_results Binary
  default={} form_tech=True store=False
• form_search_results_template Char
  default='cms_form.search_results' form_tech=True
• form_show_results_no_submit Boolean
  default=True form_tech=True
• form_show_search_form Boolean
  default=True form_tech=True
• form_show_search_form Boolean
  default=True form_tech=True
• form_title Char
  compute='_compute_form_title' form_tech=True

• form_check_permission(self)
  Just searching, nothing to check here.
• form_process_GET(self, render_values)
• form_search(self, render_values)
  Produce search results.
• form_search_domain(self, search_values)
  Build search domain.
• form_update_fields_attributes(self, _fields)
  No field should be mandatory.
• pager(self, **kw)

• w_template Char
  default='cms_form.field_widget_file'

No public methods.

No new fields.

• form_to_binary(self, value, **req_values)
• w_check_empty_value(self, value, **req_values)
• w_extract(self, **req_values)

• w_field_value Boolean
• w_template Char
  default='cms_form.field_widget_boolean'
• w_wrapper_css_klass Char
  default='form-check'
• w_wrapper_template Char
  default='cms_form.form_field_label_after_wrapper'

• w_extract(self, **req_values)
• widget_init(self, form, fname, field, **kw)

No new fields.

• html_value(self)
  @property

• w_input_type Char
  default='text'
• w_template Char
  default='cms_form.field_widget_char'
• w_valid_pattern Char
  help='Used to validate inputs with `pattern` attr'

No public methods.

• w_date_format Char
  default=''
• w_default_today Boolean
  default=True
• w_field_value Date
  default=None
• w_placeholder Char
  default=''
• w_template Char
  default='cms_form.field_widget_date'

• form_to_date(self, value, **req_values)
• w_extract(self, **req_values)
• widget_init(self, form, fname, field, **kw)

No new fields.

• w_extract(self, **req_values)

• w_template Char
  default='cms_form.field_widget_hidden'

• html_fname(self)
  @property
  Field name for final HTML markup.

• w_template Char
  default='cms_form.field_widget_image'

• w_load(self, **req_values)

No new fields.

• w_extract(self, **req_values)

No new fields.

No public methods.

• w_field_value Integer
• w_template Char
  default='cms_form.field_widget_m2o'

• form_to_m2o(self, value, **req_values)
• m2o_to_form(self, value, **req_values)
• w_extract(self, **req_values)
• w_load(self, **req_values)
• w_option_items(self)
  @property

• w_display_field Char
  default='display_name'
• w_template Char
  default='cms_form.field_widget_m2o_multi'

• form_to_m2o(self, value, **req_values)
• m2o_to_form(self, value, **req_values)

• id Id
  automatic=True
• w_css_klass Char
  default=''
• w_field Binary
  store=False
• w_field_value Char
• w_fname Char
  default=''
• w_form Binary
  store=False
• w_readonly Boolean
• w_record Binary
  store=False
• w_subfields Binary
  default={} store=False
• w_template Char
  default=''
• w_wrapper_css_klass Char
  default=''
• w_wrapper_template Char
  default=''

• html_fname(self)
  @property
• html_readonly(self)
  @property
• html_value(self)
  @property
• render(self)
• w_check_empty_value(self, value, **req_values)
• w_data_json(self)
• w_extract(self, **req_values)
  Extract value from form submit.
• w_form_model(self)
  @property
• w_form_values(self)
  @property
• w_ids_from_input(value)
  @staticmethod
  Convert list of ids from form input.
• w_load(self, **req_values)
  Load value for current field in current request.
• w_subfields_by_value(self, value='_all')
• widget_init(self, form, fname, field, data=None, subfields=None, **kw)

• w_input_max Char
  default=''
• w_input_min Char
  default=''
• w_input_type Char
  default='number'
• w_template Char
  default='cms_form.field_widget_numeric'

• html_input_max(self)
  @property
• html_input_min(self)
  @property

No new fields.

No public methods.

• w_template Char
  default='cms_form.field_widget_radio_selection'

• widget_init(self, form, fname, field, **kw)

• w_comodel_name Char
  default=''
• w_display_field Char
  default='display_name'

• w_comodel(self)
  @property
• widget_init(self, form, fname, field, **kw)

• w_template Char
  default='cms_form.field_widget_selection'

• cast_field_value(self, value)
• is_option_selected(self, opt_item)
• w_extract(self, **req_values)
• w_option_items(self)
  @property

• w_maxlength Integer
• w_template Char
  default='cms_form.field_widget_text'

• html_value(self)
  @property
• widget_init(self, form, fname, field, **kw)

• w_template Char
  default='cms_form.field_widget_x2m'

• form_to_x2many(self, value, **req_values)
• w_extract(self, **req_values)
• w_load(self, **req_values)
• x2many_to_form(self, value, **req_values)

• form_buttons_template Char
  default='cms_form.wizard_form_buttons' form_tech=True
• form_reset Boolean
  default=False form_tech=True
• form_show_progress_bar Boolean
  default=True form_tech=True
• form_step_store_all_fields Boolean
  default=True form_tech=True

• form_after_create_or_update(self, values, extra_values)
• form_init(self, request, main_object=None, page=1, wizard=None, **kw)
• form_load_defaults(self, main_object=None, request_values=None)
• form_next_url(self, main_object=None)
• form_wrapper_css_klass(self)
  @property
• is_final_step_process(self)
• wiz_configure_steps(self)
  Configure wizard steps. Each step can use a different form, for instance: return { 1: { 'form_model': 'form.a', 'title': 'Step 1', 'description': 'Preliminary info', }, 2: { 'form_model': 'form.b', 'title': 'Step 2', }, 3: { 'form_model': 'form.c', 'title': 'Step 3', 'description': 'Foo', }, }
• wiz_current_step(self)
• wiz_get_step_info(self, step)
• wiz_init(self, page=1, **kw)
• wiz_load_step(self, step=None)
• wiz_load_steps(self, steps=None)
  Load all steps data merged together.
• wiz_next_step(self)
• wiz_prev_step(self)
• wiz_save_step(self, values, step=None)
• wiz_steps(self)
  @property
• wiz_storage_get(self)
• wiz_storage_set(self, storage)