Control Properties Util

Class full path: ControlPropertiesUtil.ControlPropertiesUtil

Implementation of the control properties utilities

Functions

__init__(control_props_list, build_ele_list)

initialize

Parameters:

Name	Type	Description	Default
control_props_list	List[BuildingElementControlProperties]	list with the control properties	required
build_ele_list	List[BuildingElement]	list with the building elements	required

set_background_color(value_name, background_color, element_id='')

set the background color control property

Parameters:

Name	Type	Description	Default
value_name	str	value name of the control	required
background_color	str	background color in the format "(red, green, blue)" with "(-1, -1, -1)" as default	required
element_id	str	element ID of the building element. Defaults to "".	''

set_enable_condition(value_name, enable_condition, element_id='')

set the enable condition control property

Parameters:

Name	Type	Description	Default
value_name		value name of the control	required
enable_condition	str	enable condition control property	required
element_id		element ID of the building element. Defaults to "".	''

set_enable_function(value_name, enable_function, element_id='')

set the enable function control property

Parameters:

Name	Type	Description	Default
value_name	str	value name of the control	required
enable_function	Optional[Callable[..., bool]]	enable function control property	required
element_id	str	element ID of the building element. Defaults to "".	''

set_global_attributes(global_attributes)

set the global attributes

Parameters:

Name	Type	Description	Default
global_attributes	Dict[str, Any]	global attributes	required

set_max_value(value_name, max_value, element_id='')

set the max value control property

Parameters:

Name	Type	Description	Default
value_name		value name of the control	required
max_value		maximal value	required
element_id		element ID of the building element. Defaults to "".	''

set_min_value(value_name, min_value, element_id='')

set the min value control property

Parameters:

Name	Type	Description	Default
value_name		value name of the control	required
min_value		minimal value	required
element_id		element ID of the building element. Defaults to "".	''

set_text(value_name, text, element_id='')

set the text control property

Parameters:

Name	Type	Description	Default
value_name	str	value name of the control	required
text	str	text control property	required
element_id	str	element ID of the building element. Defaults to "".	''

set_value_list(value_name, value_list, element_id='')

set the value list control property

Parameters:

Name	Type	Description	Default
value_name	str	value name of the control	required
value_list	str	value list control property	required
element_id	str	element ID of the building element. Defaults to "".	''

set_value_list_2(value_name, value_list_2, element_id='')

set the value list 2 control property

Parameters:

Name	Type	Description	Default
value_name	str	value name of the control	required
value_list_2	str	value list 2 control property	required
element_id	str	element ID of the building element. Defaults to "".	''

set_visible_condition(value_name, visible_condition, element_id='')

set the visible condition control property

Parameters:

Name	Type	Description	Default
value_name	str	value name of the control	required
visible_condition	str	visible condition control property	required
element_id	str	element ID of the building element. Defaults to "".	''

set_visible_function(value_name, visible_function, element_id='')

set the visible function control property

Parameters:

Name	Type	Description	Default
value_name	str	value name of the control	required
visible_function	Optional[Callable[..., bool]]	visible function control property	required
element_id	str	element ID of the building element. Defaults to "".	''