PowerKeys Scripting API
    Preparing search index...

    Interface WindowInspection

    A best-effort bounded snapshot of a top-level window and its classic Win32 controls.

    interface WindowInspection {
        id: string;
        title: string;
        className: string;
        processName: string;
        pid: number;
        bounds: WindowBounds;
        clientBounds: WindowBounds | null;
        cursor: MousePosition;
        control: WindowControlInspection | null;
        statusBarText: string[];
        visibleText: string;
        allText: string;
        textPartial: boolean;
    }

    Hierarchy (View Summary)

    Index
    id title className processName pid bounds clientBounds cursor control statusBarText visibleText allText textPartial
    id: string

    Opaque window identifier (string-encoded handle). Pass to other Window methods.

    title: string

    The window title bar text.

    className: string

    The native Win32 window class name.

    processName: string

    Executable file name of the owning process (e.g. "chrome.exe").

    pid: number

    Windows process ID of the owning process.

    bounds: WindowBounds

    Outer window rectangle in physical virtual-screen coordinates.

    clientBounds: WindowBounds | null

    Client-area rectangle in physical virtual-screen coordinates, or null if Windows cannot resolve it.

    cursor: MousePosition

    Cursor position sampled before resolving the target window and control.

    control: WindowControlInspection | null

    Control under the sampled cursor within the selected target window.

    statusBarText: string[]

    Text from the first classic status bar: one entry in simple mode, otherwise one per reported part. Blank or unreadable parts are empty strings; textPartial is true when an entry is unreadable.

    visibleText: string

    Text from visible classic child controls. Fast mode is best-effort and can return no text for controls owned by another process.

    allText: string

    Text from all classic child controls, including hidden controls. Fast mode is best-effort and can return no text for controls owned by another process.

    textPartial: boolean

    Whether text is known or likely to be incomplete because of best-effort cross-process reads, redaction, a limit, timeout, access denial, or a disappearing control.

    Settings
    Member Visibility

    On This Page
    Properties