electron/docs-translations/zh-CN/api/web-contents.md

915 lines
25 KiB
Markdown
Raw Normal View History

2016-03-15 03:13:43 +00:00
# webContents
2017-02-12 15:12:33 +00:00
> 渲染和控制网页。
可使用的进程: [主进程](../tutorial/quick-start.md#main-process)
2016-03-15 03:13:43 +00:00
`webContents` 是一个
[事件发出者](http://nodejs.org/api/events.html#events_class_events_eventemitter).
它负责渲染并控制网页,也是 [`BrowserWindow`](browser-window.md) 对象的属性.一个使用 `webContents` 的例子:
```javascript
2017-02-12 15:12:33 +00:00
const {BrowserWindow} = require('electron')
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
let win = new BrowserWindow({width: 800, height: 1500})
win.loadURL('http://github.com')
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
let contents = win.webContents
console.log(contents)
```
## 方法
这些方法可以从 `webContents` 模块访问:
```javascript
const {webContents} = require('electron')
console.log(webContents)
2016-03-15 03:13:43 +00:00
```
2017-02-12 15:12:33 +00:00
### `webContents.getAllWebContents()`
返回 `WebContents[]` - 所有 `WebContents` 实例的数组。这将包含Web内容
适用于所有 windowswebviews打开的 devtools 和 devtools 扩展背景页面。
### `webContents.getFocusedWebContents()`
返回 `WebContents` - 在此应用程序中焦点的 Web 内容,否则返回`null`。
### `webContents.fromId(id)`
* `id` Integer
返回 `WebContents` - 一个给定 ID 的 WebContents 实例。
## Class: WebContents
> 渲染和控制浏览器窗口实例的内容。
可使用的进程: [主进程](../tutorial/quick-start.md#main-process)
2016-03-15 03:13:43 +00:00
## 事件
2017-02-12 15:12:33 +00:00
`webContents` 对象可发出下列事件:
2016-03-15 03:13:43 +00:00
### Event: 'did-finish-load'
2017-02-12 15:12:33 +00:00
当导航完成时发出事件,`onload` 事件也完成。
2016-03-15 03:13:43 +00:00
### Event: 'did-fail-load'
2017-02-12 15:12:33 +00:00
返回:
2016-03-15 03:13:43 +00:00
* `event` Event
* `errorCode` Integer
* `errorDescription` String
* `validatedURL` String
* `isMainFrame` Boolean
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
这个事件类似 `did-finish-load` ,但是是在加载失败或取消加载时发出, 例如, `window.stop()` 请求结束。错误代码的完整列表和它们的含义都可以在 [这里](https://code.google.com/p/chromium/codesearch#chromium/src/net/base/net_error_list.h) 找到。
2016-03-15 03:13:43 +00:00
### Event: 'did-frame-finish-load'
2017-02-12 15:12:33 +00:00
返回:
2016-03-15 03:13:43 +00:00
* `event` Event
* `isMainFrame` Boolean
2017-02-12 15:12:33 +00:00
当一个 frame 导航完成的时候发出事件。
2016-03-15 03:13:43 +00:00
### Event: 'did-start-loading'
2017-02-12 15:12:33 +00:00
当 tab 的spinner 开始 spinning的时候。
2016-03-15 03:13:43 +00:00
### Event: 'did-stop-loading'
2017-02-12 15:12:33 +00:00
当 tab 的spinner 结束 spinning的时候。
2016-03-15 03:13:43 +00:00
### Event: 'did-get-response-details'
2017-02-12 15:12:33 +00:00
返回:
2016-03-15 03:13:43 +00:00
* `event` Event
* `status` Boolean
* `newURL` String
* `originalURL` String
* `httpResponseCode` Integer
* `requestMethod` String
* `referrer` String
* `headers` Object
* `resourceType` String
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
当有关请求资源的详细信息可用的时候发出事件。
`status` 标识了 socket 链接来下载资源。
2016-03-15 03:13:43 +00:00
### Event: 'did-get-redirect-request'
2017-02-12 15:12:33 +00:00
返回:
2016-03-15 03:13:43 +00:00
* `event` Event
* `oldURL` String
* `newURL` String
* `isMainFrame` Boolean
* `httpResponseCode` Integer
* `requestMethod` String
* `referrer` String
* `headers` Object
2017-02-12 15:12:33 +00:00
当在请求资源时收到重定向的时候发出事件。
2016-03-15 03:13:43 +00:00
### Event: 'dom-ready'
2017-02-12 15:12:33 +00:00
返回:
2016-03-15 03:13:43 +00:00
* `event` Event
2017-02-12 15:12:33 +00:00
当指定 frame 中的 文档加载完成的时候发出事件。
2016-03-15 03:13:43 +00:00
### Event: 'page-favicon-updated'
2017-02-12 15:12:33 +00:00
返回:
2016-03-15 03:13:43 +00:00
* `event` Event
* `favicons` Array - Array of URLs
2017-02-12 15:12:33 +00:00
当 page 收到图标 url 的时候发出事件。
2016-03-15 03:13:43 +00:00
### Event: 'new-window'
2017-02-12 15:12:33 +00:00
返回:
2016-03-15 03:13:43 +00:00
* `event` Event
* `url` String
* `frameName` String
2017-02-12 15:12:33 +00:00
* `disposition` String - 可为 `default``foreground-tab``background-tab`
`new-window``other`
* `options` Object - 创建新的 `BrowserWindow`时使用的参数。
* `additionalFeatures` String[] - 非标准功能(功能未处理
   由 Chromium 或 Electron )赋予 `window.open()`
当 page 请求打开指定 url 窗口的时候发出事件.这可以是通过 `window.open` 或一个外部连接如 `<a target='_blank'>` 发出的请求。
默认指定 `url``BrowserWindow` 会被创建。
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
调用 `event.preventDefault()` 可以用来阻止打开窗口。
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
调用 `event.preventDefault()` 将阻止 Electron 自动创建
`BrowserWindow`。 如果调用 `event.preventDefault()` 并手动创建一个新的
`BrowserWindow`,那么你必须设置 `event.newGuest` 来引用新的 `BrowserWindow`
实例,如果不这样做可能会导致意外的行为。例如:
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
```javascript
myBrowserWindow.webContents.on('new-window', (event, url) => {
event.preventDefault()
const win = new BrowserWindow({show: false})
win.once('ready-to-show', () => win.show())
win.loadURL(url)
event.newGuest = win
})
```
2016-03-15 03:13:43 +00:00
### Event: 'will-navigate'
2017-02-12 15:12:33 +00:00
返回:
2016-03-15 03:13:43 +00:00
* `event` Event
* `url` String
2017-02-12 15:12:33 +00:00
当用户或 page 想要开始导航的时候发出事件。它可在当 `window.location` 对象改变或用户点击 page 中的链接的时候发生。
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
当使用 api`webContents.loadURL``webContents.back` 以编程方式来启动导航的时候,这个事件将不会发出。
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
它也不会在页内跳转发生,例如点击锚链接或更新 `window.location.hash`。使用 `did-navigate-in-page` 事件可以达到目的。
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
调用 `event.preventDefault()` 可以阻止导航。
2016-03-15 03:13:43 +00:00
### Event: 'did-navigate'
2017-02-12 15:12:33 +00:00
返回:
2016-03-15 03:13:43 +00:00
* `event` Event
* `url` String
2017-02-12 15:12:33 +00:00
当一个导航结束时候发出事件。
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
页内跳转时不会发出这个事件,例如点击锚链接或更新 `window.location.hash`。使用 `did-navigate-in-page` 事件可以达到目的。
2016-03-15 03:13:43 +00:00
### Event: 'did-navigate-in-page'
2017-02-12 15:12:33 +00:00
返回:
2016-03-15 03:13:43 +00:00
* `event` Event
* `url` String
2017-02-12 15:12:33 +00:00
当页内导航发生的时候发出事件。
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
当页内导航发生的时候page 的url 改变,但是不会跳出界面。例如当点击锚链接时或者 DOM 的 `hashchange` 事件发生。
2016-03-15 03:13:43 +00:00
### Event: 'crashed'
2017-02-12 15:12:33 +00:00
当渲染进程崩溃的时候发出事件。
2016-03-15 03:13:43 +00:00
### Event: 'plugin-crashed'
2017-02-12 15:12:33 +00:00
返回:
2016-03-15 03:13:43 +00:00
* `event` Event
* `name` String
* `version` String
2017-02-12 15:12:33 +00:00
当插件进程崩溃时候发出事件。
2016-03-15 03:13:43 +00:00
### Event: 'destroyed'
2017-02-12 15:12:33 +00:00
`webContents` 被删除的时候发出事件。
2016-03-15 03:13:43 +00:00
### Event: 'devtools-opened'
2017-02-12 15:12:33 +00:00
当开发者工具栏打开的时候发出事件。
2016-03-15 03:13:43 +00:00
### Event: 'devtools-closed'
2017-02-12 15:12:33 +00:00
当开发者工具栏关闭时候发出事件。
2016-03-15 03:13:43 +00:00
### Event: 'devtools-focused'
2017-02-12 15:12:33 +00:00
当开发者工具栏获得焦点或打开的时候发出事件。
2016-03-15 03:13:43 +00:00
### Event: 'certificate-error'
2017-02-12 15:12:33 +00:00
返回:
2016-03-15 03:13:43 +00:00
* `event` Event
* `url` URL
* `error` String - The error code
* `certificate` Object
* `data` Buffer - PEM encoded data
* `issuerName` String
* `callback` Function
2017-02-12 15:12:33 +00:00
当验证证书或 `url` 失败的时候发出事件。
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
使用方法类似 [`app` 的 `certificate-error` 事件](app.md#event-certificate-error)。
2016-03-15 03:13:43 +00:00
### Event: 'select-client-certificate'
2017-02-12 15:12:33 +00:00
返回:
2016-03-15 03:13:43 +00:00
* `event` Event
* `url` URL
* `certificateList` [Objects]
* `data` Buffer - PEM encoded data
* `issuerName` String - Issuer's Common Name
* `callback` Function
2017-02-12 15:12:33 +00:00
当请求客户端证书的时候发出事件。
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
使用方法类似 [`app` 的 `select-client-certificate` 事件](app.md#event-select-client-certificate)。
2016-03-15 03:13:43 +00:00
### Event: 'login'
2017-02-12 15:12:33 +00:00
返回:
2016-03-15 03:13:43 +00:00
* `event` Event
* `request` Object
* `method` String
* `url` URL
* `referrer` URL
* `authInfo` Object
* `isProxy` Boolean
* `scheme` String
* `host` String
* `port` Integer
* `realm` String
* `callback` Function
`webContents` 想做基本验证的时候发出事件.
2017-02-12 15:12:33 +00:00
使用方法类似 [the `login` event of `app`](app.md#event-login)。
2016-03-15 03:13:43 +00:00
### Event: 'found-in-page'
2017-02-12 15:12:33 +00:00
返回:
2016-03-15 03:13:43 +00:00
* `event` Event
* `result` Object
* `requestId` Integer
2017-02-12 15:12:33 +00:00
* `finalUpdate` Boolean - 标识是否还有更多的值可以查看。
* `activeMatchOrdinal` Integer (可选) - 活动匹配位置。
* `matches` Integer (可选) - 匹配数量。
* `selectionArea` Object (可选) - 协调首个匹配位置。
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
当使用 [`webContents.findInPage`] 进行页内查找并且找到可用值得时候发出事件。
2016-03-15 03:13:43 +00:00
### Event: 'media-started-playing'
2017-02-12 15:12:33 +00:00
当媒体开始播放的时候发出事件。
2016-03-15 03:13:43 +00:00
### Event: 'media-paused'
2017-02-12 15:12:33 +00:00
当媒体停止播放的时候发出事件。
2016-03-15 03:13:43 +00:00
### Event: 'did-change-theme-color'
2017-02-12 15:12:33 +00:00
当page 的主题色时候发出事件。这通常由于引入了一个 meta 标签:
2016-03-15 03:13:43 +00:00
```html
<meta name='theme-color' content='#ff0000'>
```
### Event: 'cursor-changed'
2017-02-12 15:12:33 +00:00
返回:
2016-03-15 03:13:43 +00:00
* `event` Event
* `type` String
* `image` NativeImage (可选)
* `scale` Float (可选)
当鼠标的类型发生改变的时候发出事件. `type` 的参数可以是 `default`,
`crosshair`, `pointer`, `text`, `wait`, `help`, `e-resize`, `n-resize`,
`ne-resize`, `nw-resize`, `s-resize`, `se-resize`, `sw-resize`, `w-resize`,
`ns-resize`, `ew-resize`, `nesw-resize`, `nwse-resize`, `col-resize`,
`row-resize`, `m-panning`, `e-panning`, `n-panning`, `ne-panning`, `nw-panning`,
`s-panning`, `se-panning`, `sw-panning`, `w-panning`, `move`, `vertical-text`,
`cell`, `context-menu`, `alias`, `progress`, `nodrop`, `copy`, `none`,
2017-02-12 15:12:33 +00:00
`not-allowed`, `zoom-in`, `zoom-out`, `grab`, `grabbing`, `custom`
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
如果 `type` 参数值为 `custom``image` 参数会在一个`NativeImage` 中控制自定义鼠标图片,并且 `scale` 会控制图片的缩放比例。
2016-03-15 03:13:43 +00:00
## 实例方法
`webContents` 对象有如下的实例方法:
### `webContents.loadURL(url[, options])`
* `url` URL
* `options` Object (可选)
* `httpReferrer` String - A HTTP Referrer url.
* `userAgent` String - 产生请求的用户代理
* `extraHeaders` String - 以 "\n" 分隔的额外头
2017-02-12 15:12:33 +00:00
在窗口中加载 `url``url` 必须包含协议前缀,
比如 `http://``file://`。如果加载想要忽略 http 缓存,可以使用 `pragma` 头来达到目的。
2016-03-15 03:13:43 +00:00
```javascript
const options = {'extraHeaders': 'pragma: no-cache\n'}
2016-03-15 03:13:43 +00:00
webContents.loadURL(url, options)
```
### `webContents.downloadURL(url)`
* `url` URL
2017-02-12 15:12:33 +00:00
初始化一个指定 `url` 的资源下载,不导航跳转。 `session``will-download` 事件会触发。
2016-03-15 03:13:43 +00:00
### `webContents.getURL()`
2017-02-12 15:12:33 +00:00
返回当前 page 的 url。
2016-03-15 03:13:43 +00:00
```javascript
var win = new BrowserWindow({width: 800, height: 600})
win.loadURL('http://github.com')
2016-03-15 03:13:43 +00:00
var currentURL = win.webContents.getURL()
2016-03-15 03:13:43 +00:00
```
### `webContents.getTitle()`
2017-02-12 15:12:33 +00:00
返回当前 page 的标题。
2016-03-15 03:13:43 +00:00
### `webContents.isLoading()`
2017-02-12 15:12:33 +00:00
返回一个布尔值,标识当前页是否正在加载。
2016-03-15 03:13:43 +00:00
### `webContents.isWaitingForResponse()`
2017-02-12 15:12:33 +00:00
返回一个布尔值,标识当前页是否正在等待主要资源的第一次响应。
2016-03-15 03:13:43 +00:00
### `webContents.stop()`
2017-02-12 15:12:33 +00:00
停止还为开始的导航。
2016-03-15 03:13:43 +00:00
### `webContents.reload()`
2017-02-12 15:12:33 +00:00
重载当前页。
2016-03-15 03:13:43 +00:00
### `webContents.reloadIgnoringCache()`
2017-02-12 15:12:33 +00:00
重载当前页,忽略缓存。
2016-03-15 03:13:43 +00:00
### `webContents.canGoBack()`
2017-02-12 15:12:33 +00:00
返回一个布尔值标识浏览器是否能回到前一个page。
2016-03-15 03:13:43 +00:00
### `webContents.canGoForward()`
2017-02-12 15:12:33 +00:00
返回一个布尔值标识浏览器是否能前往下一个page。
2016-03-15 03:13:43 +00:00
### `webContents.canGoToOffset(offset)`
* `offset` Integer
2017-02-12 15:12:33 +00:00
返回一个布尔值,标识浏览器是否能前往指定 `offset` 的page。
2016-03-15 03:13:43 +00:00
### `webContents.clearHistory()`
2017-02-12 15:12:33 +00:00
清除导航历史。
2016-03-15 03:13:43 +00:00
### `webContents.goBack()`
2017-02-12 15:12:33 +00:00
让浏览器回退到前一个page。
2016-03-15 03:13:43 +00:00
### `webContents.goForward()`
2017-02-12 15:12:33 +00:00
让浏览器回前往下一个page。
2016-03-15 03:13:43 +00:00
### `webContents.goToIndex(index)`
* `index` Integer
2017-02-12 15:12:33 +00:00
让浏览器回前往指定 `index` 的page。
2016-03-15 03:13:43 +00:00
### `webContents.goToOffset(offset)`
* `offset` Integer
2017-02-12 15:12:33 +00:00
导航到相对于当前页的偏移位置页。
2016-03-15 03:13:43 +00:00
### `webContents.isCrashed()`
2017-02-12 15:12:33 +00:00
渲染进程是否崩溃。
2016-03-15 03:13:43 +00:00
### `webContents.setUserAgent(userAgent)`
* `userAgent` String
2017-02-12 15:12:33 +00:00
重写本页用户代理。
2016-03-15 03:13:43 +00:00
### `webContents.getUserAgent()`
2017-02-12 15:12:33 +00:00
返回一个 `String` ,标识本页用户代理信息。
2016-03-15 03:13:43 +00:00
### `webContents.insertCSS(css)`
* `css` String
2017-02-12 15:12:33 +00:00
为当前页插入css。
2016-03-15 03:13:43 +00:00
### `webContents.executeJavaScript(code[, userGesture, callback])`
* `code` String
* `userGesture` Boolean (可选)
* `callback` Function (可选) - 脚本执行完成后调用的回调函数.
* `result`
2017-02-12 15:12:33 +00:00
评估 page `代码`
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
浏览器窗口中的一些 HTML API ,例如 `requestFullScreen`,只能被用户手势请求。设置 `userGesture``true` 可以取消这个限制。
2016-03-15 03:13:43 +00:00
### `webContents.setAudioMuted(muted)`
* `muted` Boolean
2017-02-12 15:12:33 +00:00
减缓当前页的 audio 的播放速度。
2016-03-15 03:13:43 +00:00
### `webContents.isAudioMuted()`
2017-02-12 15:12:33 +00:00
返回一个布尔值,标识当前页是否减缓了 audio 的播放速度。
2016-03-15 03:13:43 +00:00
### `webContents.undo()`
2017-02-12 15:12:33 +00:00
执行网页的编辑命令 `undo`
2016-03-15 03:13:43 +00:00
### `webContents.redo()`
2017-02-12 15:12:33 +00:00
执行网页的编辑命令 `redo`
2016-03-15 03:13:43 +00:00
### `webContents.cut()`
2017-02-12 15:12:33 +00:00
执行网页的编辑命令 `cut`
2016-03-15 03:13:43 +00:00
### `webContents.copy()`
2017-02-12 15:12:33 +00:00
执行网页的编辑命令 `copy`
2016-03-15 03:13:43 +00:00
### `webContents.paste()`
2017-02-12 15:12:33 +00:00
执行网页的编辑命令 `paste`
2016-03-15 03:13:43 +00:00
### `webContents.pasteAndMatchStyle()`
2017-02-12 15:12:33 +00:00
执行网页的编辑命令 `pasteAndMatchStyle`
2016-03-15 03:13:43 +00:00
### `webContents.delete()`
2017-02-12 15:12:33 +00:00
执行网页的编辑命令 `delete`
2016-03-15 03:13:43 +00:00
### `webContents.selectAll()`
2017-02-12 15:12:33 +00:00
执行网页的编辑命令 `selectAll`
2016-03-15 03:13:43 +00:00
### `webContents.unselect()`
2017-02-12 15:12:33 +00:00
执行网页的编辑命令 `unselect`
2016-03-15 03:13:43 +00:00
### `webContents.replace(text)`
* `text` String
2017-02-12 15:12:33 +00:00
执行网页的编辑命令 `replace`
2016-03-15 03:13:43 +00:00
### `webContents.replaceMisspelling(text)`
* `text` String
2017-02-12 15:12:33 +00:00
执行网页的编辑命令 `replaceMisspelling`
2016-03-15 03:13:43 +00:00
### `webContents.insertText(text)`
* `text` String
2017-02-12 15:12:33 +00:00
插入 `text` 到获得了焦点的元素。
2016-03-15 03:13:43 +00:00
### `webContents.findInPage(text[, options])`
2017-02-12 15:12:33 +00:00
* `text` String - 查找内容,不能为空。
2016-03-15 03:13:43 +00:00
* `options` Object (可选)
2017-02-12 15:12:33 +00:00
* `forward` Boolean - 是否向前或向后查找,默认为 `true`
* `findNext` Boolean - 当前操作是否是第一次查找或下一次查找,
默认为 `false`
* `matchCase` Boolean - 查找是否区分大小写,
默认为 `false`
* `wordStart` Boolean -是否仅以首字母查找,
默认为 `false`
* `medialCapitalAsWordStart` Boolean - 是否结合 `wordStart`,如果匹配是大写字母开头,后面接小写字母或无字母,那么就接受这个词中匹配。接受几个其它的合成词匹配,默认为 `false`
发起请求,在网页中查找所有与 `text` 相匹配的项,并且返回一个 `Integer` 来表示这个请求用的请求 Id。这个请求结果可以通过订阅
[`found-in-page`](web-contents.md#event-found-in-page) 事件来取得。
2016-03-15 03:13:43 +00:00
### `webContents.stopFindInPage(action)`
* `action` String - 指定一个行为来接替停止
2017-02-12 15:12:33 +00:00
[`webContents.findInPage`] 请求。
* `clearSelection` - 转变为一个普通的 selection。
* `keepSelection` - 清除 selection。
* `activateSelection` - 获取焦点并点击 selection node。
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
使用给定的 `action` 来为 `webContents` 停止任何 `findInPage` 请求。
2016-03-15 03:13:43 +00:00
```javascript
webContents.on('found-in-page', function (event, result) {
2016-10-03 22:48:04 +00:00
if (result.finalUpdate) webContents.stopFindInPage('clearSelection')
})
2016-03-15 03:13:43 +00:00
const requestId = webContents.findInPage('api')
2016-03-15 03:13:43 +00:00
```
### `webContents.hasServiceWorker(callback)`
* `callback` Function
2017-02-12 15:12:33 +00:00
检查是否有任何 ServiceWorker 注册了,并且返回一个布尔值,来作为 `callback`响应的标识。
2016-03-15 03:13:43 +00:00
### `webContents.unregisterServiceWorker(callback)`
* `callback` Function
2017-02-12 15:12:33 +00:00
如果存在任何 ServiceWorker则全部注销并且当JS承诺执行行或JS拒绝执行而失败的时候返回一个布尔值它标识了相应的 `callback`
2016-03-15 03:13:43 +00:00
### `webContents.print([options])`
* `options` Object (可选)
2017-02-12 15:12:33 +00:00
* `silent` Boolean - 不需要请求用户的打印设置. 默认为 `false`
* `printBackground` Boolean - 打印背景和网页图片. 默认为 `false`
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
打印窗口的网页。当设置 `silent``false` 的时候Electron 将使用系统默认的打印机和打印方式来打印。
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
在网页中调用 `window.print()` 和 调用 `webContents.print({silent: false, printBackground: false})`具有相同的作用。
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
**注意:** 在 Windows打印 API 依赖于 `pdf.dll`。如果你的应用不使用任何的打印,你可以安全删除 `pdf.dll` 来减少二进制文件的size。
2016-03-15 03:13:43 +00:00
### `webContents.printToPDF(options, callback)`
* `options` Object
2017-02-12 15:12:33 +00:00
* `marginsType` Integer - 指定使用的 margin type。默认 margin 使用 0无 margin 使用 1最小化 margin 使用 2。
* `pageSize` String - 指定生成的PDF文件的page size. 可以是 `A3`
`A4``A5``Legal`、`Letter` 和 `Tabloid`
* `printBackground` Boolean - 是否打印 css 背景。
* `printSelectionOnly` Boolean - 是否只打印选中的部分。
* `landscape` Boolean - landscape 为 `true`, portrait 为 `false`
2016-03-15 03:13:43 +00:00
* `callback` Function
2017-02-12 15:12:33 +00:00
打印窗口的网页为 pdf使用 Chromium 预览打印的自定义设置。
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
完成时使用 `callback(error, data)` 调用 `callback``data` 是一个 `Buffer` ,包含了生成的 pdf 数据、
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
默认,空的 `options` 被视为:
2016-03-15 03:13:43 +00:00
```javascript
{
marginsType: 0,
printBackground: false,
printSelectionOnly: false,
landscape: false
}
```
```javascript
const BrowserWindow = require('electron').BrowserWindow
const fs = require('fs')
2016-03-15 03:13:43 +00:00
var win = new BrowserWindow({width: 800, height: 600})
win.loadURL('http://github.com')
2016-03-15 03:13:43 +00:00
win.webContents.on('did-finish-load', function () {
2016-03-15 03:13:43 +00:00
// Use default printing options
win.webContents.printToPDF({}, function (error, data) {
if (error) throw error
fs.writeFile('/tmp/print.pdf', data, function (error) {
2016-10-03 22:48:04 +00:00
if (error) throw error
console.log('Write PDF successfully.')
2016-03-15 03:13:43 +00:00
})
})
})
2016-03-15 03:13:43 +00:00
```
### `webContents.addWorkSpace(path)`
* `path` String
2017-02-12 15:12:33 +00:00
添加指定的路径给开发者工具栏的 workspace。必须在 DevTools 创建之后使用它:
2016-03-15 03:13:43 +00:00
```javascript
mainWindow.webContents.on('devtools-opened', function () {
mainWindow.webContents.addWorkSpace(__dirname)
})
2016-03-15 03:13:43 +00:00
```
### `webContents.removeWorkSpace(path)`
* `path` String
2017-02-12 15:12:33 +00:00
从开发者工具栏的 workspace 删除指定的路径。
2016-03-15 03:13:43 +00:00
### `webContents.openDevTools([options])`
* `options` Object (可选)
* `detach` Boolean - 在一个新窗口打开开发者工具栏
2017-02-12 15:12:33 +00:00
打开开发者工具栏。
2016-03-15 03:13:43 +00:00
### `webContents.closeDevTools()`
2017-02-12 15:12:33 +00:00
关闭开发者工具栏。
2016-03-15 03:13:43 +00:00
### `webContents.isDevToolsOpened()`
2017-02-12 15:12:33 +00:00
返回布尔值,开发者工具栏是否打开。
2016-03-15 03:13:43 +00:00
### `webContents.isDevToolsFocused()`
2017-02-12 15:12:33 +00:00
返回布尔值,开发者工具栏视图是否获得焦点。
2016-03-15 03:13:43 +00:00
### `webContents.toggleDevTools()`
2017-02-12 15:12:33 +00:00
Toggles 开发者工具。
2016-03-15 03:13:43 +00:00
### `webContents.inspectElement(x, y)`
* `x` Integer
* `y` Integer
2017-02-12 15:12:33 +00:00
在 (`x`, `y`) 开始检测元素。
2016-03-15 03:13:43 +00:00
### `webContents.inspectServiceWorker()`
2017-02-12 15:12:33 +00:00
为 service worker 上下文打开开发者工具栏。
2016-03-15 03:13:43 +00:00
### `webContents.send(channel[, arg1][, arg2][, ...])`
* `channel` String
* `arg` (可选)
2017-02-12 15:12:33 +00:00
通过 `channel` 发送异步消息给渲染进程,你也可发送任意的参数。参数应该在 JSON 内部序列化,并且此后没有函数或原形链被包括了。
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
渲染进程可以通过使用 `ipcRenderer` 监听 `channel` 来处理消息。
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
例子,从主进程向渲染进程发送消息:
2016-03-15 03:13:43 +00:00
```javascript
// 主进程.
var window = null
app.on('ready', function () {
window = new BrowserWindow({width: 800, height: 600})
2016-10-03 22:48:04 +00:00
window.loadURL(`file://${__dirname}/index.html`)
window.webContents.on('did-finish-load', function () {
window.webContents.send('ping', 'whoooooooh!')
})
})
2016-03-15 03:13:43 +00:00
```
```html
<!-- index.html -->
<html>
<body>
<script>
require('electron').ipcRenderer.on('ping', function(event, message) {
2016-10-03 22:48:04 +00:00
console.log(message) // Prints "whoooooooh!"
})
2016-03-15 03:13:43 +00:00
</script>
</body>
</html>
```
### `webContents.enableDeviceEmulation(parameters)`
`parameters` Object, properties:
* `screenPosition` String - 指定需要模拟的屏幕
(默认 : `desktop`)
* `desktop`
* `mobile`
* `screenSize` Object - 设置模拟屏幕 size (screenPosition == mobile)
* `width` Integer - 设置模拟屏幕 width
* `height` Integer - 设置模拟屏幕 height
* `viewPosition` Object - 在屏幕放置 view
(screenPosition == mobile) (默认: `{x: 0, y: 0}`)
2016-10-03 22:48:04 +00:00
* `x` Integer - 设置偏移左上角的x轴
* `y` Integer - 设置偏移左上角的y轴
2016-03-15 03:13:43 +00:00
* `deviceScaleFactor` Integer - 设置设备比例因子 (如果为0默认为原始屏幕比例) (默认: `0`)
* `viewSize` Object - 设置模拟视图 size (空表示不覆盖)
* `width` Integer - 设置模拟视图 width
* `height` Integer - 设置模拟视图 height
* `fitToView` Boolean - 如果有必要的话,是否把模拟视图按比例缩放来适应可用空间 (默认: `false`)
* `offset` Object - 可用空间内的模拟视图偏移 (不在适应模式) (默认: `{x: 0, y: 0}`)
* `x` Float - 设置相对左上角的x轴偏移值
* `y` Float - 设置相对左上角的y轴偏移值
* `scale` Float - 可用空间内的模拟视图偏移 (不在适应视图模式) (默认: `1`)
2017-02-12 15:12:33 +00:00
使用给定的参数来开启设备模拟。
2016-03-15 03:13:43 +00:00
### `webContents.disableDeviceEmulation()`
2017-02-12 15:12:33 +00:00
使用 `webContents.enableDeviceEmulation` 关闭设备模拟。
2016-03-15 03:13:43 +00:00
### `webContents.sendInputEvent(event)`
* `event` Object
* `type` String (**必需**) - 事件类型,可以是 `mouseDown`,
`mouseUp`, `mouseEnter`, `mouseLeave`, `contextMenu`, `mouseWheel`,
`mouseMove`, `keyDown`, `keyUp`, `char`.
* `modifiers` Array - 事件的 modifiers 数组, 可以是
include `shift`, `control`, `alt`, `meta`, `isKeypad`, `isAutoRepeat`,
`leftButtonDown`, `middleButtonDown`, `rightButtonDown`, `capsLock`,
`numLock`, `left`, `right`.
2017-02-12 15:12:33 +00:00
向 page 发送一个输入 `event`
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
对键盘事件来说,`event` 对象还有如下属性:
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
* `keyCode` String (**必需**) - 特点是将作为键盘事件发送。可用的 key codes [Accelerator](accelerator.md)。
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
对鼠标事件来说,`event` 对象还有如下属性:
2016-03-15 03:13:43 +00:00
* `x` Integer (**required**)
* `y` Integer (**required**)
* `button` String - button 按下, 可以是 `left`, `middle`, `right`
* `globalX` Integer
* `globalY` Integer
* `movementX` Integer
* `movementY` Integer
* `clickCount` Integer
2017-02-12 15:12:33 +00:00
对鼠标滚轮事件来说,`event` 对象还有如下属性:
2016-03-15 03:13:43 +00:00
* `deltaX` Integer
* `deltaY` Integer
* `wheelTicksX` Integer
* `wheelTicksY` Integer
* `accelerationRatioX` Integer
* `accelerationRatioY` Integer
* `hasPreciseScrollingDeltas` Boolean
* `canScroll` Boolean
### `webContents.beginFrameSubscription(callback)`
* `callback` Function
2017-02-12 15:12:33 +00:00
开始订阅 提交 事件和捕获数据帧,当有提交事件时,使用 `callback(frameBuffer)` 调用 `callback`
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
`frameBuffer` 是一个包含原始像素数据的 `Buffer`,像素数据是按照 32bit BGRA 格式有效存储的,但是实际情况是取决于处理器的字节顺序的(大多数的处理器是存放小端序的,如果是在大端序的处理器上,数据是 32bit ARGB 格式)。
2016-03-15 03:13:43 +00:00
### `webContents.endFrameSubscription()`
2017-02-12 15:12:33 +00:00
停止订阅帧提交事件。
2016-03-15 03:13:43 +00:00
### `webContents.savePage(fullPath, saveType, callback)`
* `fullPath` String - 文件的完整路径.
* `saveType` String - 指定保存类型.
* `HTMLOnly` - 只保存html.
* `HTMLComplete` - 保存整个 page 内容.
* `MHTML` - 保存完整的 html 为 MHTML.
* `callback` Function - `function(error) {}`.
* `error` Error
2017-02-12 15:12:33 +00:00
如果保存界面过程初始化成功,返回 true。
2016-03-15 03:13:43 +00:00
```javascript
win.loadURL('https://github.com')
2016-03-15 03:13:43 +00:00
win.webContents.on('did-finish-load', function () {
win.webContents.savePage('/tmp/test.html', 'HTMLComplete', function (error) {
2016-10-03 22:48:04 +00:00
if (!error) console.log('Save page successfully')
})
})
2016-03-15 03:13:43 +00:00
```
## 实例属性
2017-02-12 15:12:33 +00:00
`WebContents` 对象也有下列属性:
2016-03-15 03:13:43 +00:00
### `webContents.session`
2017-02-12 15:12:33 +00:00
返回这个 `webContents` 使用的 [session](session.md) 对象。
2016-03-15 03:13:43 +00:00
### `webContents.hostWebContents`
2017-02-12 15:12:33 +00:00
返回这个 `webContents` 的父 `webContents`
2016-03-15 03:13:43 +00:00
### `webContents.devToolsWebContents`
2017-02-12 15:12:33 +00:00
获取这个 `WebContents` 的开发者工具栏的 `WebContents`
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
**注意:** 用户不可保存这个对象,因为当开发者工具栏关闭的时候它的值为 `null`
2016-03-15 03:13:43 +00:00
### `webContents.debugger`
2017-02-12 15:12:33 +00:00
调试 API 为 [remote debugging protocol][rdp] 提供交替传送。
2016-03-15 03:13:43 +00:00
```javascript
try {
win.webContents.debugger.attach('1.1')
} catch (err) {
console.log('Debugger attach failed : ', err)
2016-10-03 22:48:04 +00:00
}
2016-03-15 03:13:43 +00:00
win.webContents.debugger.on('detach', function (event, reason) {
console.log('Debugger detached due to : ', reason)
})
2016-03-15 03:13:43 +00:00
win.webContents.debugger.on('message', function (event, method, params) {
2016-10-03 22:48:04 +00:00
if (method === 'Network.requestWillBeSent') {
if (params.request.url === 'https://www.github.com') {
win.webContents.debugger.detach()
2016-10-03 22:48:04 +00:00
}
2016-03-15 03:13:43 +00:00
}
})
win.webContents.debugger.sendCommand('Network.enable')
2016-03-15 03:13:43 +00:00
```
#### `webContents.debugger.attach([protocolVersion])`
2017-02-12 15:12:33 +00:00
* `protocolVersion` String (可选) - 请求调试协议版本。
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
添加 `webContents` 调试。
2016-03-15 03:13:43 +00:00
#### `webContents.debugger.isAttached()`
2017-02-12 15:12:33 +00:00
返回一个布尔值,标识是否已经给 `webContents` 添加了调试。
2016-03-15 03:13:43 +00:00
#### `webContents.debugger.detach()`
2017-02-12 15:12:33 +00:00
删除 `webContents` 调试。
2016-03-15 03:13:43 +00:00
#### `webContents.debugger.sendCommand(method[, commandParams, callback])`
2017-02-12 15:12:33 +00:00
* `method` String - 方法名, 应该是由远程调试协议定义的方法。
* `commandParams` Object (可选) - 请求参数为 JSON 对象。
2016-03-15 03:13:43 +00:00
* `callback` Function (可选) - Response
2017-02-12 15:12:33 +00:00
* `error` Object - 错误消息,标识命令失败。
* `result` Object - 回复在远程调试协议中由 'returns'属性定义的命令描述。
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
发送给定命令给调试目标。
2016-03-15 03:13:43 +00:00
### Event: 'detach'
2016-03-15 03:13:43 +00:00
* `event` Event
2017-02-12 15:12:33 +00:00
* `reason` String - 拆分调试器原因。
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
在调试 session 结束时发出事件.这在 `webContents` 关闭时或 `webContents` 请求开发者工具栏时发生。
2016-03-15 03:13:43 +00:00
### Event: 'message'
2016-03-15 03:13:43 +00:00
* `event` Event
2017-02-12 15:12:33 +00:00
* `method` String - 方法名。
* `params` Object - 在远程调试协议中由 'parameters' 属性定义的事件参数。
2016-03-15 03:13:43 +00:00
2017-02-12 15:12:33 +00:00
每当调试目标发出事件时发出。
2016-03-15 03:13:43 +00:00
[rdp]: https://developer.chrome.com/devtools/docs/debugger-protocol
[`webContents.findInPage`]: web-contents.md#webcontentsfindinpagetext-options