RibbonBackstage
12 Sep 20253 minutes to read
Defines the items of Ribbon.
Properties
enablePersistence boolean
Enable or disable persisting component’s state between page reloads.
Defaults to false
enableRtl boolean
Enable or disable rendering component in right to left direction.
Defaults to false
locale string
Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.
Defaults to ’’
Methods
addBackstageItems
Add items to Backstage Menu.
| Parameter | Type | Description |
|---|---|---|
| items | BackstageItemModel[] |
Gets the items to be added. |
| target | string |
Gets the target item to add the items. |
| isAfter | boolean |
Gets the boolean value to add the items after or before the target item. |
| isUniqueId (optional) | boolean |
Gets whether the target provided is uniqueId or not. |
Returns void
addEventListener
Adds the handler to the given event listener.
| Parameter | Type | Description |
|---|---|---|
| eventName | string |
A String that specifies the name of the event |
| handler | Function |
Specifies the call to run when the event occurs. |
Returns void
appendTo
Appends the control within the given HTML element
| Parameter | Type | Description |
|---|---|---|
| selector (optional) |
string | HTMLElement
|
Target element where control needs to be appended |
Returns void
attachUnloadEvent
Adding unload event to persist data when enable persistence true
Returns void
dataBind
When invoked, applies the pending property changes immediately to the component.
Returns void
detachUnloadEvent
Removing unload event to persist data when enable persistence true
Returns void
getLocalData
Returns the persistence data for component
Returns any
getRootElement
Returns the route element of the component
Returns HTMLElement
handleUnload
Handling unload event to persist data when enable persistence true
Returns void
hideBackstage
Hides the backstage dynamically.
Returns void
refresh
Applies all the pending property changes and render the component again.
Returns void
removeBackstageItems
Remove items from Backstage Menu.
| Parameter | Type | Description |
|---|---|---|
| items | string[] |
Gets the items to be removed. |
| isUniqueId (optional) | boolean |
Gets whether the target provided is uniqueId or not. |
Returns void
removeEventListener
Removes the handler from the given event listener.
| Parameter | Type | Description |
|---|---|---|
| eventName | string |
A String that specifies the name of the event to remove |
| handler | Function |
Specifies the function to remove |
Returns void
showBackstage
Renders the backstage dynamically.
Returns void
Inject
Dynamically injects the required modules to the component.
| Parameter | Type | Description |
|---|---|---|
| moduleList | Function[] |
? |
Returns void