namespace sap.ui.core.ExtensionPoint

Visiblity: public
Available since: N/A
Module: sap/ui/core/ExtensionPoint
Application Component: CA-UI5-COR

Nodes Overview

Node Description

Methods Overview

Method Description
sap.ui.core.ExtensionPoint.load

Creates 0..n UI5 controls from an ExtensionPoint.

One control if the ExtensionPoint is e.g. filled with a View, zero for extension points without configured extension and n controls for multi-root Fragments as extension.

sap.ui.core.ExtensionPoint.registerExtensionProvider

Registers a function, which will be called by the XMLTemplateProcessor to retrieve an ExtensionProvider Class. The registered module will be loaded once an ExtensionPoint is encountered during XMLView processing.

sap.ui.core.ExtensionPoint.load

Creates 0..n UI5 controls from an ExtensionPoint.

One control if the ExtensionPoint is e.g. filled with a View, zero for extension points without configured extension and n controls for multi-root Fragments as extension.

Param Type DefaultValue Description
mOptions object

an object map (see below)

container sap.ui.core.mvc.View sap.ui.core.Fragment

The view or fragment containing the extension point

name string

The mOptions.name is used to identify the extension point in the customizing

createDefaultContent function

Optional callback function creating default content, returning an array of controls. It is executed when there's no customizing, if not provided, no default content will be rendered. mOptions.createDefaultContent might also return a Promise, which resolves with an array of controls.

async boolean false

Whether the ExtensionPoint content should be loaded asynchronously

sap.ui.core.ExtensionPoint.registerExtensionProvider

Registers a function, which will be called by the XMLTemplateProcessor to retrieve an ExtensionProvider Class. The registered module will be loaded once an ExtensionPoint is encountered during XMLView processing.

Param Type DefaultValue Description
fnExtensionProvider function undefined null

Accepted values are: function, null or undefined. If a function is given it must either return the module path of the ExtensionProvider class or undefined in case flex is not active. If null or undefined is given, an already registered provider is removed.