Interface · Components
WindowProps
Properties accepted by the Window component.
@sharpts/gui 0.0.0-local · SharpTS 7c6010104a43Members
allowDrop
allowDrop?: booleanAllows native drag data to be dropped on this control.
Default: false · Inherited
Type: boolean
automationName
automationName?: stringAccessible automation name exposed to assistive technology and test drivers.
Inherited
Type: string
canResize
canResize?: booleanWhether the user can resize the window.
Default: true
Type: boolean
canvasLeft
canvasLeft?: numberCanvas left coordinate when parented by Canvas.
Default: "NaN" · Inherited
Type: number
canvasTop
canvasTop?: numberCanvas top coordinate when parented by Canvas.
Default: "NaN" · Inherited
Type: number
capturePointerOnPress
capturePointerOnPress?: booleanCaptures a pressed pointer until release, cancellation, unmount, or disposal.
Default: false · Inherited
Type: boolean
children
children?: GuiElement | nullChild content accepted by Window.
Inherited
Type: GuiElement | null
classes
classes?: readonly string[]Avalonia style classes applied to the native control.
Inherited
Type: readonly string[]
dock
dock?: DockEdge used when the control is placed in a DockPanel.
Default: "left" · Values: "left", "top", "right", "bottom" · Inherited
Type: Dock
gridColumn
gridColumn?: numberZero-based column index when the control is placed in a Grid.
Default: 0 · Inherited
Type: number
gridColumnSpan
gridColumnSpan?: numberNumber of Grid columns occupied by the control.
Default: 1 · Inherited
Type: number
gridRow
gridRow?: numberZero-based row index when the control is placed in a Grid.
Default: 0 · Inherited
Type: number
gridRowSpan
gridRowSpan?: numberNumber of Grid rows occupied by the control.
Default: 1 · Inherited
Type: number
height
height?: numberPreferred control height in device-independent pixels.
Default: "NaN" · Inherited
Type: number
horizontalAlignment
horizontalAlignment?: HorizontalAlignmentHorizontal alignment within the parent layout slot.
Default: "stretch" · Values: "left", "center", "right", "stretch" · Inherited
Type: HorizontalAlignment
isEnabled
isEnabled?: booleanWhether the control accepts user interaction.
Default: true · Inherited
Type: boolean
isVisible
isVisible?: booleanWhether the control participates in rendering and layout.
Default: true · Inherited
Type: boolean
margin
margin?: ThicknessSpace outside the control.
Default: 0 · Inherited
Type: Thickness
maxHeight
maxHeight?: numberMaximum permitted control height.
Default: "Infinity" · Inherited
Type: number
maxWidth
maxWidth?: numberMaximum permitted control width.
Default: "Infinity" · Inherited
Type: number
minHeight
minHeight?: numberMinimum permitted control height.
Default: 0 · Inherited
Type: number
minWidth
minWidth?: numberMinimum permitted control width.
Default: 0 · Inherited
Type: number
onCloseRequested
onCloseRequested?(): booleanHandles and cancels a native close request when the callback returns true.
onDragOver
onDragOver?(event: DropEvent): DropEffectChooses the accepted native drag effect.
Inherited
onDrop
onDrop?(event: DropEvent): void | Promise<unknown>Receives normalized text and local-file drop data.
Inherited
onKeyDown
onKeyDown?(event: KeyEvent): booleanHandles a normalized key-down event.
Inherited
onKeyUp
onKeyUp?(event: KeyEvent): booleanHandles a normalized key-up event.
Inherited
onMetricsChanged
onMetricsChanged?(event: WindowMetricsEvent): voidReceives coalesced post-layout client size, scaling, state, and current-display work-area metrics.
onPointerCancel
onPointerCancel?(event: PointerEvent): booleanHandles cancellation or loss of an active pointer capture using its last known local state.
Inherited
onPointerDown
onPointerDown?(event: PointerEvent): booleanHandles a normalized pointer press.
Inherited
onPointerMove
onPointerMove?(event: PointerEvent): booleanHandles normalized pointer movement.
Inherited
onPointerUp
onPointerUp?(event: PointerEvent): booleanHandles a normalized pointer release.
Inherited
opacity
opacity?: numberOpacity from zero (transparent) to one (opaque).
Default: 1 · Inherited
Type: number
ref
ref?: ControlRef<WindowHandle>Receives the retained native control handle.
Inherited
Type: ControlRef<WindowHandle>
theme
theme?: ThemeLight, dark, or operating-system window theme.
Default: "system" · Values: "system", "light", "dark"
Type: Theme
title
title?: stringText displayed in the window title bar.
Default: "SharpTS GUI"
Type: string
toolTip
toolTip?: stringText shown when the pointer pauses over the control.
Inherited
Type: string
verticalAlignment
verticalAlignment?: VerticalAlignmentVertical alignment within the parent layout slot.
Default: "stretch" · Values: "top", "center", "bottom", "stretch" · Inherited
Type: VerticalAlignment
width
width?: numberPreferred control width in device-independent pixels.
Default: "NaN" · Inherited
Type: number
Related symbols
Source
SharpTS.Gui.Sdk/GuiPackage/control-surface.generated.ts:18 at SharpTS revision 7c6010104a43c34d80e9d44704cf179bc4f5b8e0.