Documentation
On this page

Interface · Components

WindowProps

Properties accepted by the Window component.

@sharpts/gui 0.0.0-local · SharpTS 7c6010104a43

Members

allowDrop

allowDrop?: boolean

Allows native drag data to be dropped on this control.

Default: false · Inherited

Type: boolean

automationName

automationName?: string

Accessible automation name exposed to assistive technology and test drivers.

Inherited

Type: string

canResize

canResize?: boolean

Whether the user can resize the window.

Default: true

Type: boolean

canvasLeft

canvasLeft?: number

Canvas left coordinate when parented by Canvas.

Default: "NaN" · Inherited

Type: number

canvasTop

canvasTop?: number

Canvas top coordinate when parented by Canvas.

Default: "NaN" · Inherited

Type: number

capturePointerOnPress

capturePointerOnPress?: boolean

Captures a pressed pointer until release, cancellation, unmount, or disposal.

Default: false · Inherited

Type: boolean

children

children?: GuiElement | null

Child 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?: Dock

Edge used when the control is placed in a DockPanel.

Default: "left" · Values: "left", "top", "right", "bottom" · Inherited

Type: Dock

gridColumn

gridColumn?: number

Zero-based column index when the control is placed in a Grid.

Default: 0 · Inherited

Type: number

gridColumnSpan

gridColumnSpan?: number

Number of Grid columns occupied by the control.

Default: 1 · Inherited

Type: number

gridRow

gridRow?: number

Zero-based row index when the control is placed in a Grid.

Default: 0 · Inherited

Type: number

gridRowSpan

gridRowSpan?: number

Number of Grid rows occupied by the control.

Default: 1 · Inherited

Type: number

height

height?: number

Preferred control height in device-independent pixels.

Default: "NaN" · Inherited

Type: number

horizontalAlignment

horizontalAlignment?: HorizontalAlignment

Horizontal alignment within the parent layout slot.

Default: "stretch" · Values: "left", "center", "right", "stretch" · Inherited

Type: HorizontalAlignment

isEnabled

isEnabled?: boolean

Whether the control accepts user interaction.

Default: true · Inherited

Type: boolean

isVisible

isVisible?: boolean

Whether the control participates in rendering and layout.

Default: true · Inherited

Type: boolean

margin

margin?: Thickness

Space outside the control.

Default: 0 · Inherited

Type: Thickness

maxHeight

maxHeight?: number

Maximum permitted control height.

Default: "Infinity" · Inherited

Type: number

maxWidth

maxWidth?: number

Maximum permitted control width.

Default: "Infinity" · Inherited

Type: number

minHeight

minHeight?: number

Minimum permitted control height.

Default: 0 · Inherited

Type: number

minWidth

minWidth?: number

Minimum permitted control width.

Default: 0 · Inherited

Type: number

onCloseRequested

onCloseRequested?(): boolean

Handles and cancels a native close request when the callback returns true.

onDragOver

onDragOver?(event: DropEvent): DropEffect

Chooses 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): boolean

Handles a normalized key-down event.

Inherited

onKeyUp

onKeyUp?(event: KeyEvent): boolean

Handles a normalized key-up event.

Inherited

onMetricsChanged

onMetricsChanged?(event: WindowMetricsEvent): void

Receives coalesced post-layout client size, scaling, state, and current-display work-area metrics.

onPointerCancel

onPointerCancel?(event: PointerEvent): boolean

Handles cancellation or loss of an active pointer capture using its last known local state.

Inherited

onPointerDown

onPointerDown?(event: PointerEvent): boolean

Handles a normalized pointer press.

Inherited

onPointerMove

onPointerMove?(event: PointerEvent): boolean

Handles normalized pointer movement.

Inherited

onPointerUp

onPointerUp?(event: PointerEvent): boolean

Handles a normalized pointer release.

Inherited

opacity

opacity?: number

Opacity 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?: Theme

Light, dark, or operating-system window theme.

Default: "system" · Values: "system", "light", "dark"

Type: Theme

title

title?: string

Text displayed in the window title bar.

Default: "SharpTS GUI"

Type: string

toolTip

toolTip?: string

Text shown when the pointer pauses over the control.

Inherited

Type: string

verticalAlignment

verticalAlignment?: VerticalAlignment

Vertical alignment within the parent layout slot.

Default: "stretch" · Values: "top", "center", "bottom", "stretch" · Inherited

Type: VerticalAlignment

width

width?: number

Preferred control width in device-independent pixels.

Default: "NaN" · Inherited

Type: number

Source

SharpTS.Gui.Sdk/GuiPackage/control-surface.generated.ts:18 at SharpTS revision 7c6010104a43c34d80e9d44704cf179bc4f5b8e0.