The screen regions are places in the software pages where addons can load their components dynamically.
Such components are looked for by the system on startup. To create such a component, make a class that inherits the ITfRegionComponent<T> interface where T is the region class name.
Each of these components also defines Scopes that are applicable for the them, which can further limit the cases when they appear.
The currently supported regions are:
| class | description | scope definition | code |
|---|---|---|---|
TfAdminPageScreenRegionContext |
loads page in the Administration Panel > Pages section | by component ID | class example |
TfDataProviderDisplaySettingsScreenRegionContext |
loads data provider custom settings on its details page | by type (data provider) | class example |
TfDataProviderManageSettingsScreenRegionContext |
loads data provider custom settings edit form on its management modal | by type (data provider) | class example |
TfPageScreenRegionContext |
loads page in the public > Pages section under the user dashboard | by component ID | class example |
TfSpaceViewSelectorActionScreenRegionContext |
loads in space view connector actions dropdown menu | no scope | class example |
TfSpaceViewToolBarActionScreenRegionContext |
loads in space view toolbar | no scope | class |
TfTemplateProcessorDisplaySettingsScreenRegionContext |
loads on the template details screen to present the template processor custom options | by type (template processor) | class example |
TfTemplateProcessorHelpScreenRegionContext |
loads on the template details when the help modal is clicked | by type (template processor) | class example |
TfTemplateProcessorManageSettingsScreenRegionContext |
loads on the template details when the manage template processor setting modal is presented | by type (template processor) | class example |
TfTemplateProcessorResultPreviewComponentContextContext |
loads during the template generation action is triggered during the preview results step | by type (template processor) | class example |
TfTemplateProcessorResultScreenRegionContext |
loads during the template generation action is triggered during the final result step | by type (template processor) | class example |