Skip to content

ControlPropertiesUtil

Implementation of the control properties service

ControlPropertiesUtil

Canonical path: ControlPropertiesUtil.ControlPropertiesUtil

Implementation of the control properties utilities

__init__ 

__init__(
    control_props_list: List[BuildingElementControlProperties],
    build_ele_list: List[BuildingElement],
) -> None

initialize

Parameters:

set_background_color 

set_background_color(
    value_name: str, background_color: str, element_id: str = ""
) -> None

set the background color control property

Parameters:

  • value_name (str) –

    value name of the control

  • background_color (str) –

    background color in the format "(red, green, blue)" with "(-1, -1, -1)" as default

  • element_id (str, default: '' ) –

    element ID of the building element. Defaults to "".

set_enable_condition 

set_enable_condition(
    value_name: str, enable_condition: str, element_id: str = ""
) -> None

set the enable condition control property

Parameters:

  • value_name ( ) –

    value name of the control

  • enable_condition (str) –

    enable condition control property

  • element_id ( , default: '' ) –

    element ID of the building element. Defaults to "".

set_enable_function 

set_enable_function(
    value_name: str,
    enable_function: Optional[Callable[..., bool]],
    element_id: str = "",
) -> None

set the enable function control property

Parameters:

  • value_name (str) –

    value name of the control

  • enable_function (Optional[Callable[..., bool]]) –

    enable function control property

  • element_id (str, default: '' ) –

    element ID of the building element. Defaults to "".

set_global_attributes 

set_global_attributes(global_attributes: Dict[str, Any])

set the global attributes

Parameters:

  • global_attributes (Dict[str, Any]) –

    global attributes

set_max_value 

set_max_value(value_name: str, max_value: str, element_id: str = '') -> None

set the max value control property

Parameters:

  • value_name –

    value name of the control

  • max_value ( ) –

    maximal value

  • element_id –

    element ID of the building element. Defaults to "".

set_min_value 

set_min_value(value_name: str, min_value: str, element_id: str = '') -> None

set the min value control property

Parameters:

  • value_name –

    value name of the control

  • min_value ( ) –

    minimal value

  • element_id –

    element ID of the building element. Defaults to "".

set_text 

set_text(value_name: str, text: str, element_id: str = '') -> None

set the text control property

Parameters:

  • value_name (str) –

    value name of the control

  • text (str) –

    text control property

  • element_id (str, default: '' ) –

    element ID of the building element. Defaults to "".

set_value_list 

set_value_list(value_name: str, value_list: str, element_id: str = '') -> None

set the value list control property

Parameters:

  • value_name (str) –

    value name of the control

  • value_list (str) –

    value list control property

  • element_id (str, default: '' ) –

    element ID of the building element. Defaults to "".

set_value_list_2 

set_value_list_2(
    value_name: str, value_list_2: str, element_id: str = ""
) -> None

set the value list 2 control property

Parameters:

  • value_name (str) –

    value name of the control

  • value_list_2 (str) –

    value list 2 control property

  • element_id (str, default: '' ) –

    element ID of the building element. Defaults to "".

set_visible_condition 

set_visible_condition(
    value_name: str, visible_condition: str, element_id: str = ""
) -> None

set the visible condition control property

Parameters:

  • value_name (str) –

    value name of the control

  • visible_condition (str) –

    visible condition control property

  • element_id (str, default: '' ) –

    element ID of the building element. Defaults to "".

set_visible_function 

set_visible_function(
    value_name: str,
    visible_function: Optional[Callable[..., bool]],
    element_id: str = "",
) -> None

set the visible function control property

Parameters:

  • value_name (str) –

    value name of the control

  • visible_function (Optional[Callable[..., bool]]) –

    visible function control property

  • element_id (str, default: '' ) –

    element ID of the building element. Defaults to "".