7.1.5 Controlling Component Availability

Using the {with/}…{apply/} directive, developers can always apply your template component by name, but you decide if they can use it in Page Designer by setting its Available as options.

If you select any of these options, Page Designer displays your component in the region palette and the list of region types. The particular option you choose controls how the Property Editor presents the component's features.

A Region-only component displays your custom attributes and slots, but offers no additional built-in settings. Choosing Single (Partial) or Multiple (Report) causes the Property Editor to show the Source section so a developer can configure a data source. Its columns are then available to reference in custom attributes. The data source for a Single (Partial) template component must return at most one row, or a runtime error results. Given this guarantee, the component renders only its Partial template with no additional space used for pagination controls.

When you make your template component available as a Multiple (Report) component, additional settings related to pagination and grouping appear. If you checked Has Row Selection Support when defining it, further settings appear for this capability.