1 set_df_property Options

A comprehensive reference guide to dynamically modifying DocField properties at runtime — because hardcoding forms is so last season.

Table of Contents

• 📖 Overview
• 📋 Visibility & Display Properties
• 📋 List View & Filter Properties
• 📋 Field Type & Options
• 📋 Validation & Mandatory Properties
• 📋 Child Table Properties
• 📋 Data & Formatting Properties
• 🔒 Permission & Security Properties
• 💻 Advanced Properties
• 📝 Practical Usage Examples
• 💡 Important Notes
• 📦 Related Methods

📖 Overview

set_df_property is a powerful method in Frappe's client-side JavaScript API that allows you to dynamically modify DocField properties at runtime. Below is the complete reference of all available property options organized by category.

📋 Visibility & Display Properties

These properties control whether and how fields appear in the form.

📋 List View & Filter Properties

These properties determine field visibility and filtering in list views.

📋 Field Type & Options

These properties change the field's datatype and available values.

Supported fieldtypes include: Data, Text, Text Editor, Select, Link, Dynamic Link, Currency, Float, Int, Date, Datetime, Checkbox, Table, and 20+ others.[docs.frappe]

📋 Validation & Mandatory Properties

These control field validation and whether fields are required.

📋 Child Table Properties

These properties are specific to Table fields.

📋 Data & Formatting Properties

These properties affect how field values are stored and displayed.

🔒 Permission & Security Properties

These properties control field-level access and data safety.

💻 Advanced Properties

These are less commonly used but provide specialized functionality.

📝 Practical Usage Examples

Scenario 1: Hide a field based on another field's value

frappe.ui.form.on('Sales Order', {
  customer_type(frm) {
    let show_gst = frm.doc.customer_type === 'Business';
    frm.set_df_property('gst_number', 'hidden', show_gst ? 0 : 1);
  }
});

Scenario 2: Disable child table row operations

frappe.ui.form.on('Purchase Order', {
  refresh(frm) {
    if (frm.doc.docstatus === 1) { // Document is submitted
      frm.set_df_property('items', 'cannot_add_rows', true);
      frm.set_df_property('items', 'cannot_delete_rows', true);
    }
  }
});

Scenario 3: Make field mandatory conditionally

frappe.ui.form.on('Leave Application', {
  leave_type(frm) {
    let is_half_day = frm.doc.leave_type === 'Half Day';
    frm.set_df_property('half_day_type', 'reqd', is_half_day ? 1 : 0);
    frm.set_df_property('half_day_type', 'hidden', is_half_day ? 0 : 1);
  }
});

Scenario 4: Dynamic Select field options

frappe.ui.form.on('Lead', {
  country(frm) {
    let options = frm.doc.country === 'India' 
      ? ['Delhi', 'Mumbai', 'Bangalore']
      : ['New York', 'Los Angeles'];
    frm.set_df_property('city', 'options', options);
    frm.refresh_field('city');
  }
});

💡 Important Notes

1. Always refresh the field after using set_df_property for visual changes to take effect: frm.refresh_field('fieldname')
2. Use eval: prefix for conditional properties: 'eval:doc.field=="value"'
3. Child table properties can be set the same way as regular fields
4. For child table row properties, you may need to iterate through rows: frm.fields_dict.items.grid.df.cannot_add_rows = true
5. Performance tip: Set properties in setup or onload events rather than repeatedly in refresh

📦 Related Methods

• frm.toggle_reqd(fieldname, boolean) — Toggle mandatory status more efficiently
• frm.toggle_display(fieldname, boolean) — Toggle visibility
• frm.toggle_enable(fieldname, boolean) — Toggle read-only status
• frm.refresh_field(fieldname) — Refresh field UI after changes

This comprehensive set of properties makes set_df_property an essential tool for creating dynamic, responsive forms in Frappe applications.frappe+3