Die Dokumentation ab Version 39.5.17 von PLANTA project finden Sie in der neuen PLANTA Online-Hilfe

Current Web>CustomizingDokumentation>PythonApi>CuAccessApi

cu_access
- Functions
- Examples
  - Customizing a link/button/context entry to modify customizing objects

cu_access

The cu_access module lets you open customizer modules

Functions

Tip:

All edit_* functions also accept a list of IDs as parameter

Function	Parameters	Return Value	Description
edit_dataarea`(dataarea_id, module_settings={})`	dataarea_id: DA module_settings: Parameters to pass to `Module.open_module`	The edit `Module`	Open the corresponding edit module for the given ids or add them to an already open edit module and focus the newly added record
edit_datafield_directly`(df_fieldnumber, module_settings={})`	df_fieldnumber: DF module_settings: Parameters to pass to `Module.open_module`	The edit `Module`	Open the corresponding edit module for the given ids or add them to an already open edit module and focus the newly added record
edit_dataitems`(dataitems, module_settings={})`	dataitems: DI module_settings: Parameters to pass to `Module.open_module`	The edit `Module`	Open the corresponding edit module for the given ids or add them to an already open edit module and focus the newly added record
edit_datatable`(table_number, module_settings={})`	table_number: DT module_settings: Parameters to pass to `Module.open_module`	The edit `Module`	Open the corresponding edit module for the given ids or add them to an already open edit module and focus the newly added record
edit_effect`(effect_id, module_settings={})`	effect_id: Effekt-ID module_settings: Parameters to pass to `Module.open_module`	The edit `Module`	Open the corresponding edit module for the given ids or add them to an already open edit module and focus the newly added record
edit_exit`(exit_id, module_settings={})`	exit_id: EXIT module_settings: Parameters to pass to `Module.open_module`	The edit `Module`	Open the corresponding edit module for the given ids or add them to an already open edit module and focus the newly added record
edit_format`(format_id, module_settings={})`	format_id: Format-ID module_settings: Parameters to pass to `Module.open_module`	The edit `Module`	Open the corresponding edit module for the given ids or add them to an already open edit module and focus the newly added record
edit_module`(modules, module_settings=None, search_opened_target_mod_instance_in_all_panels=False)`	modules: MOD module_settings: Parameters to pass to `Module.open_module` search_opened_target_mod_instance_in_all_panels: Controls wether the edit module should be searched for in all panels or only the current panel	The edit `Module`	Open the corresponding edit module for the given ids or add them to an already open edit module and focus the newly added record
edit_role`(role_id, module_settings={})`	role_id: Rolle module_settings: Parameters to pass to `Module.open_module`	The edit `Module`	Open the corresponding edit module for the given ids or add them to an already open edit module and focus the newly added record
edit_symbol`(symbol_id, module_settings={})`	symbol_id: Symbol-ID module_settings: Parameters to pass to `Module.open_module`	The edit `Module`	Open the corresponding edit module for the given ids or add them to an already open edit module and focus the newly added record
edit_workarea`(workarea_id, module_settings={})`	workarea_id: Arbeitsgebiet module_settings: Parameters to pass to `Module.open_module`	The edit `Module`	Open the corresponding edit module for the given ids or add them to an already open edit module and focus the newly added record
is_current_user_customizer`(show_msg=True)`	show_msg: If `True`, a message will be shown when the user doesn't have customizing rights	`True` or `False`	Queries the value of Customizer-Rechte for the currently logged in user
is_user_customizer`(user)`	user: Benutzer	`True` or `False`	Queries the value of Customizer-Rechte

Examples

Customizing a link/button/context entry to modify customizing objects

The macro module 009C8A should be used for any functionality where you want to open a customizing edit module.

Supported object	target value
Module	`module`
Datatable	`datatable`
Dataitem	`dataitem`
Dataarea	`dataarea`
Symbol	`symbol`
Format	`format`
Effect	`effect`
Exit	`exit`
Work Area	`workarea`

This macro implements access to the editor modules in a uniform way that is consistent with how PLANTA deals with things like clicking a link in a record while having 3 other records marked, trying to access customizing module without having customizing rights and other scenarios.

Using the Datenfeld-Konfiguration you can specify what object you are dealing with, where the primary key can be read from in the record and how the module should be opened if you want to fine tune it.

The minimum configuration to make 009C8A work looks like this:

{'python_id': 'di', 'target': 'dataitem'}

The python_id key refers to the DF-Python-ID of the field where the primary key is located and target refers to the object type we are dealing with. See the table above for the list of supported objects.

Additionally you can specify any of the parameters you would normally specify in Module.open_module:

{'python_id': 'dt_id', 'target': 'datatable', 'dock_style': DOCK_STYLE_RIGHT}

39.5 Venus Current DE

PLANTA project

PLANTA pulse

PLANTA project

Suche in Topic-Namen
Suche in Topic-Inhalten