API Reference › appui-react › ContentView › FrameworkContent

FrameworkContent Interface

UiFramework.content interface

Methods

Name Description
addFloatingContentControl(contentControl?: ContentControl): void    
contentSupportsCamera(content: undefined | ContentControl): boolean Determines if viewport supports use of a camera.  
dropFloatingContentControl(contentControl?: ContentControl): void    
getActive(): ReactNode Gets the active content as a React.ReactNode.  
getActiveContentControl(): undefined | ContentControl Return the active ContentControl.  
isContent3dView(content: undefined | ContentControl): boolean Determines if content displays a 3d view.  
isContentDrawingView(content: undefined | ContentControl): boolean Determines if content displays a Drawing view.  
isContentOrthographicView(content: undefined | ContentControl): boolean Determines if content displays a Orthographic view.  
isContentSheetView(content: undefined | ContentControl): boolean Determines if content displays a Sheet view.  
isContentSpatialView(content: undefined | ContentControl): boolean Determines if content displays a Spatial view.  
refreshActive(activeContent: ReactNode): void Refreshes the active ContentControl  
setActive(activeContent?: ReactNode, forceEventProcessing?: boolean): void Sets the active ContentControl  
setMouseDown(mouseDown: boolean): void Sets the mouse down status for a content view  

Properties

Name Type Description
dialogs Readonly FrameworkStackedDialog<ContentDialogInfo> & { onContentDialogChangedEvent: ContentDialogChangedEvent } Manage dialogs displaying managed content.  
isMouseDown Readonly boolean Determines if the mouse is down in a content view  
layouts Readonly { activeContentGroup: undefined | ContentGroup, activeLayout: undefined | ContentLayoutDef, add: undefined, find: undefined, getForGroup: undefined, getKey: undefined, refreshActive: undefined, setActive: undefined, setActiveContentGroup: undefined } Manage content layouts.  
onActiveContentChangedEvent Readonly ActiveContentChangedEvent Gets the ActiveContentChangedEvent  
onAvailableContentChangedEvent Readonly UiEvent<{ contentId: string }> Fires when floating contents are added or removed  
onMouseDownChangedEvent Readonly MouseDownChangedEvent Gets the MouseDownChangedEvent  

Defined in

Last Updated: 05 April, 2024