Interface: SteamHTMLSurface

SteamWorksNamespace.SteamHTMLSurface

Table of contents

Properties

• AddHeader
• AllowStartRequest
• CopyToClipboard
• CreateBrowser
• ExecuteJavascript
• FileLoadDialogResponse
• Find
• GetLinkAtPosition
• GoBack
• GoForward
• Init
• JSDialogResponse
• KeyChar
• KeyDown
• KeyUp
• LoadURL
• MouseDoubleClick
• MouseDown
• MouseMove
• MouseUp
• MouseWheel
• OpenDeveloperTools
• PasteFromClipboard
• Reload
• RemoveBrowser
• SetBackgroundMode
• SetCookie
• SetDPIScalingFactor
• SetHorizontalScroll
• SetKeyFocus
• SetPageScaleFactor
• SetSize
• SetVerticalScroll
• Shutdown
• StopFind
• StopLoad
• ViewSource

Properties

AddHeader

• AddHeader: (unBrowserHandle: number, pchKey: string, pchValue: string) => undefined

Type declaration

▸ (unBrowserHandle, pchKey, pchValue): undefined

Parameters

Name	Type
unBrowserHandle	number
pchKey	string
pchValue	string

Returns

undefined

Defined in

index.d.ts:2763

---

AllowStartRequest

• AllowStartRequest: (unBrowserHandle: number, bAllowed: boolean) => undefined

Type declaration

▸ (unBrowserHandle, bAllowed): undefined

Parameters

Name	Type
unBrowserHandle	number
bAllowed	boolean

Returns

undefined

Defined in

index.d.ts:2787

---

CopyToClipboard

• CopyToClipboard: (unBrowserHandle: number) => undefined

Type declaration

▸ (unBrowserHandle): undefined

Parameters

Name	Type
unBrowserHandle	number

Returns

undefined

Defined in

index.d.ts:2777

---

CreateBrowser

• CreateBrowser: (pchUserAgent: string, pchUserCSS: string) => Promise<{ unBrowserHandle: number }>

Type declaration

▸ (pchUserAgent, pchUserCSS): Promise<{ unBrowserHandle: number }>

Parameters

Name	Type
pchUserAgent	string
pchUserCSS	string

Returns

Promise<{ unBrowserHandle: number }>

Defined in

index.d.ts:2755

---

ExecuteJavascript

• ExecuteJavascript: (unBrowserHandle: number, pchScript: string) => undefined

Type declaration

▸ (unBrowserHandle, pchScript): undefined

Parameters

Name	Type
unBrowserHandle	number
pchScript	string

Returns

undefined

Defined in

index.d.ts:2764

---

FileLoadDialogResponse

• FileLoadDialogResponse: (unBrowserHandle: number, pchSelectedFiles: unknown) => undefined

Type declaration

▸ (unBrowserHandle, pchSelectedFiles): undefined

Parameters

Name	Type
unBrowserHandle	number
pchSelectedFiles	unknown

Returns

undefined

Defined in

index.d.ts:2789

---

Find

• Find: (unBrowserHandle: number, pchSearchStr: string, bCurrentlyInFind: boolean, bReverse: boolean) => undefined

Type declaration

▸ (unBrowserHandle, pchSearchStr, bCurrentlyInFind, bReverse): undefined

Parameters

Name	Type
unBrowserHandle	number
pchSearchStr	string
bCurrentlyInFind	boolean
bReverse	boolean

Returns

undefined

Defined in

index.d.ts:2779

---

GetLinkAtPosition

• GetLinkAtPosition: (unBrowserHandle: number, x: number, y: number) => undefined

Type declaration

▸ (unBrowserHandle, x, y): undefined

Parameters

Name	Type
unBrowserHandle	number
x	number
y	number

Returns

undefined

Defined in

index.d.ts:2781

---

GoBack

• GoBack: (unBrowserHandle: number) => undefined

Type declaration

▸ (unBrowserHandle): undefined

Parameters

Name	Type
unBrowserHandle	number

Returns

undefined

Defined in

index.d.ts:2761

---

GoForward

• GoForward: (unBrowserHandle: number) => undefined

Type declaration

▸ (unBrowserHandle): undefined

Parameters

Name	Type
unBrowserHandle	number

Returns

undefined

Defined in

index.d.ts:2762

---

Init

• Init: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Defined in

index.d.ts:2753

---

JSDialogResponse

• JSDialogResponse: (unBrowserHandle: number, bResult: boolean) => undefined

Type declaration

▸ (unBrowserHandle, bResult): undefined

Parameters

Name	Type
unBrowserHandle	number
bResult	boolean

Returns

undefined

Defined in

index.d.ts:2788

---

KeyChar

• KeyChar: (unBrowserHandle: number, cUnicodeChar: number, eHTMLKeyModifiers: unknown) => undefined

Type declaration

▸ (unBrowserHandle, cUnicodeChar, eHTMLKeyModifiers): undefined

Parameters

Name	Type
unBrowserHandle	number
cUnicodeChar	number
eHTMLKeyModifiers	unknown

Returns

undefined

Defined in

index.d.ts:2772

---

KeyDown

• KeyDown: (unBrowserHandle: number, nNativeKeyCode: number, eHTMLKeyModifiers: unknown, bIsSystemKey: boolean) => undefined

Type declaration

▸ (unBrowserHandle, nNativeKeyCode, eHTMLKeyModifiers, bIsSystemKey): undefined

Parameters

Name	Type
unBrowserHandle	number
nNativeKeyCode	number
eHTMLKeyModifiers	unknown
bIsSystemKey	boolean

Returns

undefined

Defined in

index.d.ts:2770

---

KeyUp

• KeyUp: (unBrowserHandle: number, nNativeKeyCode: number, eHTMLKeyModifiers: unknown) => undefined

Type declaration

▸ (unBrowserHandle, nNativeKeyCode, eHTMLKeyModifiers): undefined

Parameters

Name	Type
unBrowserHandle	number
nNativeKeyCode	number
eHTMLKeyModifiers	unknown

Returns

undefined

Defined in

index.d.ts:2771

---

LoadURL

• LoadURL: (unBrowserHandle: number, pchURL: string, pchPostData: string) => undefined

Type declaration

▸ (unBrowserHandle, pchURL, pchPostData): undefined

Parameters

Name	Type
unBrowserHandle	number
pchURL	string
pchPostData	string

Returns

undefined

Defined in

index.d.ts:2757

---

MouseDoubleClick

• MouseDoubleClick: (unBrowserHandle: number, eMouseButton: unknown) => undefined

Type declaration

▸ (unBrowserHandle, eMouseButton): undefined

Parameters

Name	Type
unBrowserHandle	number
eMouseButton	unknown

Returns

undefined

Defined in

index.d.ts:2767

---

MouseDown

• MouseDown: (unBrowserHandle: number, eMouseButton: unknown) => undefined

Type declaration

▸ (unBrowserHandle, eMouseButton): undefined

Parameters

Name	Type
unBrowserHandle	number
eMouseButton	unknown

Returns

undefined

Defined in

index.d.ts:2766

---

MouseMove

• MouseMove: (unBrowserHandle: number, x: number, y: number) => undefined

Type declaration

▸ (unBrowserHandle, x, y): undefined

Parameters

Name	Type
unBrowserHandle	number
x	number
y	number

Returns

undefined

Defined in

index.d.ts:2768

---

MouseUp

• MouseUp: (unBrowserHandle: number, eMouseButton: unknown) => undefined

Type declaration

▸ (unBrowserHandle, eMouseButton): undefined

Parameters

Name	Type
unBrowserHandle	number
eMouseButton	unknown

Returns

undefined

Defined in

index.d.ts:2765

---

MouseWheel

• MouseWheel: (unBrowserHandle: number, nDelta: number) => undefined

Type declaration

▸ (unBrowserHandle, nDelta): undefined

Parameters

Name	Type
unBrowserHandle	number
nDelta	number

Returns

undefined

Defined in

index.d.ts:2769

---

OpenDeveloperTools

• OpenDeveloperTools: (unBrowserHandle: number) => undefined

Type declaration

▸ (unBrowserHandle): undefined

Parameters

Name	Type
unBrowserHandle	number

Returns

undefined

Defined in

index.d.ts:2786

---

PasteFromClipboard

• PasteFromClipboard: (unBrowserHandle: number) => undefined

Type declaration

▸ (unBrowserHandle): undefined

Parameters

Name	Type
unBrowserHandle	number

Returns

undefined

Defined in

index.d.ts:2778

---

Reload

• Reload: (unBrowserHandle: number) => undefined

Type declaration

▸ (unBrowserHandle): undefined

Parameters

Name	Type
unBrowserHandle	number

Returns

undefined

Defined in

index.d.ts:2760

---

RemoveBrowser

• RemoveBrowser: (unBrowserHandle: number) => undefined

Type declaration

▸ (unBrowserHandle): undefined

Parameters

Name	Type
unBrowserHandle	number

Returns

undefined

Defined in

index.d.ts:2756

---

SetBackgroundMode

• SetBackgroundMode: (unBrowserHandle: number, bBackgroundMode: boolean) => undefined

Type declaration

▸ (unBrowserHandle, bBackgroundMode): undefined

Parameters

Name	Type
unBrowserHandle	number
bBackgroundMode	boolean

Returns

undefined

Defined in

index.d.ts:2784

---

SetCookie

• SetCookie: (pchHostname: string, pchKey: string, pchValue: string, pchPath: string, nExpires: number, bSecure: boolean, bHTTPOnly: boolean) => undefined

Type declaration

▸ (pchHostname, pchKey, pchValue, pchPath, nExpires, bSecure, bHTTPOnly): undefined

Parameters

Name	Type
pchHostname	string
pchKey	string
pchValue	string
pchPath	string
nExpires	number
bSecure	boolean
bHTTPOnly	boolean

Returns

undefined

Defined in

index.d.ts:2782

---

SetDPIScalingFactor

• SetDPIScalingFactor: (unBrowserHandle: number, flDPIScaling: number) => undefined

Type declaration

▸ (unBrowserHandle, flDPIScaling): undefined

Parameters

Name	Type
unBrowserHandle	number
flDPIScaling	number

Returns

undefined

Defined in

index.d.ts:2785

---

SetHorizontalScroll

• SetHorizontalScroll: (unBrowserHandle: number, nAbsolutePixelScroll: number) => undefined

Type declaration

▸ (unBrowserHandle, nAbsolutePixelScroll): undefined

Parameters

Name	Type
unBrowserHandle	number
nAbsolutePixelScroll	number

Returns

undefined

Defined in

index.d.ts:2773

---

SetKeyFocus

• SetKeyFocus: (unBrowserHandle: number, bHasKeyFocus: boolean) => undefined

Type declaration

▸ (unBrowserHandle, bHasKeyFocus): undefined

Parameters

Name	Type
unBrowserHandle	number
bHasKeyFocus	boolean

Returns

undefined

Defined in

index.d.ts:2775

---

SetPageScaleFactor

• SetPageScaleFactor: (unBrowserHandle: number, flZoom: number, nPointX: number, nPointY: number) => undefined

Type declaration

▸ (unBrowserHandle, flZoom, nPointX, nPointY): undefined

Parameters

Name	Type
unBrowserHandle	number
flZoom	number
nPointX	number
nPointY	number

Returns

undefined

Defined in

index.d.ts:2783

---

SetSize

• SetSize: (unBrowserHandle: number, unWidth: number, unHeight: number) => undefined

Type declaration

▸ (unBrowserHandle, unWidth, unHeight): undefined

Parameters

Name	Type
unBrowserHandle	number
unWidth	number
unHeight	number

Returns

undefined

Defined in

index.d.ts:2758

---

SetVerticalScroll

• SetVerticalScroll: (unBrowserHandle: number, nAbsolutePixelScroll: number) => undefined

Type declaration

▸ (unBrowserHandle, nAbsolutePixelScroll): undefined

Parameters

Name	Type
unBrowserHandle	number
nAbsolutePixelScroll	number

Returns

undefined

Defined in

index.d.ts:2774

---

Shutdown

• Shutdown: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Defined in

index.d.ts:2754

---

StopFind

• StopFind: (unBrowserHandle: number) => undefined

Type declaration

▸ (unBrowserHandle): undefined

Parameters

Name	Type
unBrowserHandle	number

Returns

undefined

Defined in

index.d.ts:2780

---

StopLoad

• StopLoad: (unBrowserHandle: number) => undefined

Type declaration

▸ (unBrowserHandle): undefined

Parameters

Name	Type
unBrowserHandle	number

Returns

undefined

Defined in

index.d.ts:2759

---

ViewSource

• ViewSource: (unBrowserHandle: number) => undefined

Type declaration

▸ (unBrowserHandle): undefined

Parameters

Name	Type
unBrowserHandle	number

Returns

undefined

Defined in

index.d.ts:2776