seitime-frappe/frappe/docs/current/models/custom/property_setter.html
2015-12-04 10:22:48 +05:30

324 lines
No EOL
7.5 KiB
HTML

<!-- title: Property Setter -->
<div class="dev-header">
<a class="btn btn-default btn-sm" disabled style="margin-bottom: 10px;">
Version 6.x.x</a>
<a class="btn btn-default btn-sm" href="https://github.com/frappe/frappe/tree/develop/frappe/custom/doctype/property_setter"
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>tabProperty Setter</code></p>
Property Setter overrides a standard DocType or Field property
<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 ><code>help</code></td>
<td >
HTML</td>
<td >
Help
</td>
<td></td>
</tr>
<tr class="info">
<td>2</td>
<td ><code>sb0</code></td>
<td >
Section Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>3</td>
<td class="danger" title="Mandatory"><code>doctype_or_field</code></td>
<td >
Select</td>
<td >
DocType or Field
</td>
<td>
<pre>
DocField
DocType</pre>
</td>
</tr>
<tr >
<td>4</td>
<td ><code>value</code></td>
<td >
Text</td>
<td >
Set Value
<p class="text-muted small">
New value to be set</p>
</td>
<td></td>
</tr>
<tr >
<td>5</td>
<td ><code>column_break0</code></td>
<td class="info">
Column Break</td>
<td >
</td>
<td></td>
</tr>
<tr >
<td>6</td>
<td class="danger" title="Mandatory"><code>doc_type</code></td>
<td >
Link</td>
<td >
DocType
</td>
<td>
<a href="https://frappe.github.io/frappe/current/models/core/doctype">DocType</a>
</td>
</tr>
<tr >
<td>7</td>
<td ><code>field_name</code></td>
<td >
Data</td>
<td >
Field Name
<p class="text-muted small">
ID (name) of the entity whose property is to be set</p>
</td>
<td></td>
</tr>
<tr >
<td>8</td>
<td class="danger" title="Mandatory"><code>property</code></td>
<td >
Data</td>
<td >
Property
</td>
<td></td>
</tr>
<tr >
<td>9</td>
<td ><code>property_type</code></td>
<td >
Data</td>
<td >
Property Type
</td>
<td></td>
</tr>
<tr >
<td>10</td>
<td ><code>default_value</code></td>
<td >
Data</td>
<td >
Default Value
</td>
<td></td>
</tr>
</tbody>
</table>
<hr>
<h3>Controller</h3>
<h4>frappe.custom.doctype.property_setter.property_setter</h4>
<h3 style="font-weight: normal;">Class <b>PropertySetter</b></h3>
<p style="padding-left: 30px;"><i>Inherits from frappe.model.document.Document</i></h4>
<div class="docs-attr-desc"><p></p>
</div>
<div style="padding-left: 30px;">
<p class="docs-attr-name">
<a name="autoname" href="#autoname" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>autoname</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_defaults" href="#get_defaults" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_defaults</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_field_ids" href="#get_field_ids" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_field_ids</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_property_list" href="#get_property_list" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_property_list</b>
<i class="text-muted">(self, dt)</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_setup_data" href="#get_setup_data" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>get_setup_data</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="on_update" href="#on_update" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
<b>on_update</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>delete other property setters on this, if this is new</p>
</div>
<br>
</div>
<hr>
<p class="docs-attr-name">
<a name="frappe.custom.doctype.property_setter.property_setter.make_property_setter" href="#frappe.custom.doctype.property_setter.property_setter.make_property_setter" class="text-muted small">
<i class="icon-link small" style="color: #ccc;"></i></a>
frappe.custom.doctype.property_setter.property_setter.<b>make_property_setter</b>
<i class="text-muted">(doctype, fieldname, property, value, property_type, for_doctype=False, validate_fields_for_doctype=True)</i>
</p>
<div class="docs-attr-desc"><p><span class="text-muted">No docs</span></p>
</div>
<br>
<!-- autodoc -->
<!-- jinja -->
<!-- static -->