FloatingContentControl Class
Beta
Extends
Methods
| Name | Description | |
|---|---|---|
| constructor(uniqueId: string, name: string, node: ReactNode): FloatingContentControl | Creates an instance of ContentControl. |
Inherited methods
| Name | Inherited from | Description |
|---|---|---|
| getKeyedReactNode(): ReactNode Protected | ContentControl | |
| getReactNode(): ReactNode Protected | ContentControl | |
| getType(): ConfigurableUiControlType | ContentControl | Gets the type of ConfigurableUiControl, which is 'Content' in this case |
| onActivated(): void | ContentControl | Called when this ContentControl is activated |
| onDeactivated(): void | ContentControl | Called when this ContentControl is deactivated |
| onFrontstageDeactivated(): void | ContentControl | Called when Frontstage is deactivated. |
| onFrontstageReady(): void | ContentControl | Called when Frontstage is ready. |
| onInitialize(): void | ContentControl | Called to initialize the ConfigurableUiControl. |
Inherited properties
| Name | Type | Inherited from | Description |
|---|---|---|---|
| _appDataOptions Protected | any | ContentControl | |
| _reactNode Protected | ReactNode | ContentControl | |
| applicationData Accessor ReadOnly | any | ContentControl | allow options set via appData to be seen by API calls |
| classId Accessor ReadOnly | string | ContentControl | Gets the class Id of configurable element |
| controlId Accessor ReadOnly | string | ContentControl | Returns the ID of this ConfigurableUiControl. |
| isReady Accessor ReadOnly | Promise<void> | ContentControl | Returns a promise that resolves when the control is ready for usage. |
| isViewport Accessor ReadOnly | boolean | ContentControl | Returns true if this control is a Viewport control. |
| name Accessor ReadOnly | string | ContentControl | Get internal name of configurable element. If no name is defined in configuration then the name will match the UniqueId. |
| navigationAidControl Accessor ReadOnly | string | ContentControl | Get the NavigationAidControl associated with this ContentControl |
| reactNode Accessor | ReactNode | ContentControl | The React node associated with this control. |
| viewport Accessor ReadOnly | undefined | ScreenViewport | ContentControl | Returns the ScreenViewport if isViewport is true |
Defined in
Last Updated: 20 June, 2023