490 lines
No EOL
12 KiB
HTML
490 lines
No EOL
12 KiB
HTML
<!-- title: Web Form -->
|
|
|
|
|
|
|
|
|
|
|
|
<div class="dev-header">
|
|
|
|
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
|
|
Version 6.10.1</a>
|
|
|
|
|
|
<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/tree/develop/frappe/website/doctype/web_form"
|
|
target="_blank" style="margin-left: 10px; margin-bottom: 10px;"><i class="octicon octicon-mark-github"></i> Source</a>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
|
|
<p><b>Table Name:</b> <code>tabWeb Form</code></p>
|
|
|
|
|
|
|
|
|
|
<h3>Fields</h3>
|
|
|
|
<table class="table table-bordered" style="table-layout: fixed;">
|
|
<thead>
|
|
<tr>
|
|
<th style="width: 5%">Sr</th>
|
|
<th style="width: 25%">Fieldname</th>
|
|
<th style="width: 20%">Type</th>
|
|
<th style="width: 25%">Label</th>
|
|
<th style="width: 25%">Options</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
|
|
<tr >
|
|
<td>1</td>
|
|
<td class="danger" title="Mandatory"><code>title</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Title
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>2</td>
|
|
<td class="danger" title="Mandatory"><code>page_name</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Page Name
|
|
<p class="text-muted small">
|
|
Website URL</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>3</td>
|
|
<td class="danger" title="Mandatory"><code>doc_type</code></td>
|
|
<td >
|
|
Link</td>
|
|
<td >
|
|
Select DocType
|
|
|
|
</td>
|
|
<td>
|
|
|
|
|
|
|
|
|
|
<a href="https://frappe.github.io/frappe/current/models/core/doctype">DocType</a>
|
|
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>4</td>
|
|
<td ><code>column_break_4</code></td>
|
|
<td class="info">
|
|
Column Break</td>
|
|
<td >
|
|
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>5</td>
|
|
<td ><code>is_standard</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Is Standard
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>6</td>
|
|
<td ><code>published</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Published
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>7</td>
|
|
<td ><code>login_required</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Login Required
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>8</td>
|
|
<td ><code>allow_edit</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Allow Edit
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>9</td>
|
|
<td ><code>allow_multiple</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Allow Multiple
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>10</td>
|
|
<td ><code>allow_delete</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Allow Delete
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>11</td>
|
|
<td ><code>allow_comments</code></td>
|
|
<td >
|
|
Check</td>
|
|
<td >
|
|
Allow Comments
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>12</td>
|
|
<td ><code>fields</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Fields
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>13</td>
|
|
<td ><code>introduction_text</code></td>
|
|
<td >
|
|
Text</td>
|
|
<td >
|
|
Introduction
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>14</td>
|
|
<td ><code>web_form_fields</code></td>
|
|
<td >
|
|
Table</td>
|
|
<td >
|
|
Web Form Fields
|
|
|
|
</td>
|
|
<td>
|
|
|
|
|
|
|
|
|
|
<a href="https://frappe.github.io/frappe/current/models/website/web_form_field">Web Form Field</a>
|
|
|
|
|
|
|
|
</td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>15</td>
|
|
<td ><code>actions</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Actions
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>16</td>
|
|
<td ><code>success_message</code></td>
|
|
<td >
|
|
Text</td>
|
|
<td >
|
|
Success Message
|
|
<p class="text-muted small">
|
|
Message to be displayed on successful completion</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>17</td>
|
|
<td ><code>success_url</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Success URL
|
|
<p class="text-muted small">
|
|
Go to this url after completing the form.</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr class="info">
|
|
<td>18</td>
|
|
<td ><code>advanced</code></td>
|
|
<td >
|
|
Section Break</td>
|
|
<td >
|
|
Advanced
|
|
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>19</td>
|
|
<td ><code>web_page_link_text</code></td>
|
|
<td >
|
|
Data</td>
|
|
<td >
|
|
Web Page Link Text
|
|
<p class="text-muted small">
|
|
Text to be displayed for Link to Web Page if this form has a web page. Link route will be automatically generated based on `page_name` and `parent_website_route`</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
<tr >
|
|
<td>20</td>
|
|
<td ><code>breadcrumbs</code></td>
|
|
<td >
|
|
Small Text</td>
|
|
<td >
|
|
Breadcrumbs
|
|
<p class="text-muted small">
|
|
In JSON as [{"title":"Jobs", "name":"jobs"}]</p>
|
|
</td>
|
|
<td></td>
|
|
</tr>
|
|
|
|
</tbody>
|
|
</table>
|
|
|
|
|
|
<hr>
|
|
<h3>Controller</h3>
|
|
<h4>frappe.website.doctype.web_form.web_form</h4>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<h3 style="font-weight: normal;">Class <b>WebForm</b></h3>
|
|
|
|
<p style="padding-left: 30px;"><i>Inherits from frappe.website.website_generator.WebsiteGenerator</i></h4>
|
|
|
|
<div class="docs-attr-desc"><p></p>
|
|
</div>
|
|
<div style="padding-left: 30px;">
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="get_context" href="#get_context" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>get_context</b>
|
|
<i class="text-muted">(self, context)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="get_layout" href="#get_layout" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>get_layout</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="get_parents" href="#get_parents" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>get_parents</b>
|
|
<i class="text-muted">(self, context)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="onload" href="#onload" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>onload</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="use_meta_fields" href="#use_meta_fields" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>use_meta_fields</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="validate" href="#validate" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
<b>validate</b>
|
|
<i class="text-muted">(self)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
</div>
|
|
<hr>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/frappe.website.doctype.web_form.web_form.accept</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.website.doctype.web_form.web_form.accept" href="#frappe.website.doctype.web_form.web_form.accept" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.website.doctype.web_form.web_form.<b>accept</b>
|
|
<i class="text-muted">()</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p><span class="label label-info">Public API</span>
|
|
<br><code>/api/method/frappe.website.doctype.web_form.web_form.delete</code>
|
|
</p>
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.website.doctype.web_form.web_form.delete" href="#frappe.website.doctype.web_form.web_form.delete" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.website.doctype.web_form.web_form.<b>delete</b>
|
|
<i class="text-muted">(web_form, name)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.website.doctype.web_form.web_form.get_web_form_list" href="#frappe.website.doctype.web_form.web_form.get_web_form_list" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.website.doctype.web_form.web_form.<b>get_web_form_list</b>
|
|
<i class="text-muted">(doctype, txt, filters, limit_start, limit_page_length=20)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<p class="docs-attr-name">
|
|
<a name="frappe.website.doctype.web_form.web_form.has_web_form_permission" href="#frappe.website.doctype.web_form.web_form.has_web_form_permission" class="text-muted small">
|
|
<i class="icon-link small" style="color: #ccc;"></i></a>
|
|
frappe.website.doctype.web_form.web_form.<b>has_web_form_permission</b>
|
|
<i class="text-muted">(doctype, name, ptype=read)</i>
|
|
</p>
|
|
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
|
|
</div>
|
|
<br>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
<!-- autodoc -->
|
|
<!-- jinja -->
|
|
<!-- static --> |