Property handlers

Description of the Property handler functions available in Schematic Editor and Schematic API

Property handlers are functions that are defined on the property level. Table 1 contains a summary of the Property handler functions possible for Schematic Editor components.

Table 1. Property handlers
Property handler When called
property_value_changed
  • Called after the property value is changed, but also during model or library loading.
  • Parameters:
    • mdl - Schematic API object,
    • container_handle - item handle object. Can be either a component handle or a mask handle.
    • property_handle - property handle.
    • old_value - old property value,
    • new_value - new property value.
property_value_edited
  • Called after the property value is changed in the Component Properties dialog, but changes are still not applied by pressing OK button.
  • This handler is executed strictly in the context of Schematic Editor's UI.
  • Parameters:
    • mdl - Schematic API object,
    • container_handle - item handle object. Can be either a component handle or a mask handle.
    • property_handle - property handle.
    • new_value - property value as set in the component properties dialog.
button_clicked
  • Called after the Property button is clicked (when the Widget is set to Button).
  • This handler is executed strictly in the context of Schematic Editor's UI.
  • Parameters:
    • mdl - Schematic API object,
    • container_handle - item handle object. Can be either a component handle or a mask handle.
    • property_handle - property handle.