contextMenus.html revision ac1e49eb6695f711d72215fcdf9388548942a00d
1<!DOCTYPE html><!-- This page is a placeholder for generated extensions api doc. Note: 2 1) The <head> information in this page is significant, should be uniform 3 across api docs and should be edited only with knowledge of the 4 templating mechanism. 5 3) All <body>.innerHTML is genereated as an rendering step. If viewed in a 6 browser, it will be re-generated from the template, json schema and 7 authored overview content. 8 4) The <body>.innerHTML is also generated by an offline step so that this 9 page may easily be indexed by search engines. 10--><html xmlns="http://www.w3.org/1999/xhtml"><head> 11 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> 12 <link href="css/ApiRefStyles.css" rel="stylesheet" type="text/css"> 13 <link href="css/print.css" rel="stylesheet" type="text/css" media="print"> 14 <script type="text/javascript" src="/third_party/jstemplate/jstemplate_compiled.js"> 15 </script> 16 <script type="text/javascript" src="js/api_page_generator.js"></script> 17 <script type="text/javascript" src="js/bootstrap.js"></script> 18 <script type="text/javascript" src="js/sidebar.js"></script> 19 <title>Context Menus - Google Chrome Extensions - Google Code</title></head> 20 <body> <div id="gc-container" class="labs"> 21 <div id="devModeWarning"> 22 You are viewing extension docs in chrome via the 'file:' scheme: are you expecting to see local changes when you refresh? You'll need run chrome with --allow-file-access-from-files. 23 </div> 24 <!-- SUBTEMPLATES: DO NOT MOVE FROM THIS LOCATION --> 25 <!-- In particular, sub-templates that recurse, must be used by allowing 26 jstemplate to make a copy of the template in this section which 27 are not operated on by way of the jsskip="true" --> 28 <div style="display:none"> 29 30 <!-- VALUE --> 31 <div id="valueTemplate"> 32 <dt> 33 <var>paramName</var> 34 <em> 35 36 <!-- TYPE --> 37 <div style="display:inline"> 38 ( 39 <span class="optional">optional</span> 40 <span class="enum">enumerated</span> 41 <span id="typeTemplate"> 42 <span> 43 <a> Type</a> 44 </span> 45 <span> 46 <span> 47 array of <span><span></span></span> 48 </span> 49 <span>paramType</span> 50 <span></span> 51 </span> 52 </span> 53 ) 54 </div> 55 56 </em> 57 </dt> 58 <dd class="todo"> 59 Undocumented. 60 </dd> 61 <dd> 62 Description of this parameter from the json schema. 63 </dd> 64 <dd> 65 This parameter was added in version 66 <b><span></span></b>. 67 You must omit this parameter in earlier versions, 68 and you may omit it in any version. If you require this 69 parameter, the manifest key 70 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 71 can ensure that your extension won't be run in an earlier browser version. 72 </dd> 73 74 <!-- OBJECT PROPERTIES --> 75 <dd> 76 <dl> 77 <div> 78 <div> 79 </div> 80 </div> 81 </dl> 82 </dd> 83 84 <!-- FUNCTION PARAMETERS --> 85 <dd> 86 <div></div> 87 </dd> 88 89 </div> <!-- /VALUE --> 90 91 <div id="functionParametersTemplate"> 92 <h5>Parameters</h5> 93 <dl> 94 <div> 95 <div> 96 </div> 97 </div> 98 </dl> 99 </div> 100 </div> <!-- /SUBTEMPLATES --> 101 102 <a id="top"></a> 103 <div id="skipto"> 104 <a href="#gc-pagecontent">Skip to page content</a> 105 <a href="#gc-toc">Skip to main navigation</a> 106 </div> 107 <!-- API HEADER --> 108 <table id="header" width="100%" cellspacing="0" border="0"> 109 <tbody><tr> 110 <td valign="middle"><a href="http://code.google.com/"><img src="images/code_labs_logo.gif" height="43" width="161" alt="Google Code Labs" style="border:0; margin:0;"></a></td> 111 <td valign="middle" width="100%" style="padding-left:0.6em;"> 112 <form action="http://www.google.com/cse" id="cse" style="margin-top:0.5em"> 113 <div id="gsc-search-box"> 114 <input type="hidden" name="cx" value="002967670403910741006:61_cvzfqtno"> 115 <input type="hidden" name="ie" value="UTF-8"> 116 <input type="text" name="q" value="" size="55"> 117 <input class="gsc-search-button" type="submit" name="sa" value="Search"> 118 <br> 119 <span class="greytext">e.g. "page action" or "tabs"</span> 120 </div> 121 </form> 122 123 <script type="text/javascript" src="http://www.google.com/jsapi"></script> 124 <script type="text/javascript">google.load("elements", "1", {packages: "transliteration"});</script> 125 <script type="text/javascript" src="http://www.google.com/coop/cse/t13n?form=cse&t13n_langs=en"></script> 126 <script type="text/javascript" src="http://www.google.com/coop/cse/brand?form=cse&lang=en"></script> 127 </td> 128 </tr> 129 </tbody></table> 130 131 <div id="codesiteContent" class=""> 132 133 <a id="gc-topnav-anchor"></a> 134 <div id="gc-topnav"> 135 <h1>Google Chrome Extensions (<a href="http://code.google.com/labs/">Labs</a>)</h1> 136 <ul id="home" class="gc-topnav-tabs"> 137 <li id="home_link"> 138 <a href="index.html" title="Google Chrome Extensions home page">Home</a> 139 </li> 140 <li id="docs_link"> 141 <a href="docs.html" title="Official Google Chrome Extensions documentation">Docs</a> 142 </li> 143 <li id="faq_link"> 144 <a href="faq.html" title="Answers to frequently asked questions about Google Chrome Extensions">FAQ</a> 145 </li> 146 <li id="samples_link"> 147 <a href="samples.html" title="Sample extensions (with source code)">Samples</a> 148 </li> 149 <li id="group_link"> 150 <a href="http://groups.google.com/a/chromium.org/group/chromium-extensions" title="Google Chrome Extensions developer forum">Group</a> 151 </li> 152 </ul> 153 </div> <!-- end gc-topnav --> 154 155 <div class="g-section g-tpl-170"> 156 <!-- SIDENAV --> 157 <div class="g-unit g-first" id="gc-toc"> 158 <ul> 159 <li><a href="getstarted.html">Getting Started</a></li> 160 <li><a href="overview.html">Overview</a></li> 161 <li><a href="whats_new.html">What's New?</a></li> 162 <li><h2><a href="devguide.html">Developer's Guide</a></h2> 163 <ul> 164 <li>Browser UI 165 <ul> 166 <li><a href="browserAction.html">Browser Actions</a></li> 167 <li class="leftNavSelected">Context Menus</li> 168 <li><a href="notifications.html">Desktop Notifications</a></li> 169 <li><a href="omnibox.html">Omnibox</a></li> 170 <li><a href="options.html">Options Pages</a></li> 171 <li><a href="override.html">Override Pages</a></li> 172 <li><a href="pageAction.html">Page Actions</a></li> 173 </ul> 174 </li> 175 <li>Browser Interaction 176 <ul> 177 <li><a href="bookmarks.html">Bookmarks</a></li> 178 <li><a href="cookies.html">Cookies</a></li> 179 <li><a href="events.html">Events</a></li> 180 <li><a href="history.html">History</a></li> 181 <li><a href="management.html">Management</a></li> 182 <li><a href="tabs.html">Tabs</a></li> 183 <li><a href="windows.html">Windows</a></li> 184 </ul> 185 </li> 186 <li>Implementation 187 <ul> 188 <li><a href="a11y.html">Accessibility</a></li> 189 <li><a href="background_pages.html">Background Pages</a></li> 190 <li><a href="content_scripts.html">Content Scripts</a></li> 191 <li><a href="xhr.html">Cross-Origin XHR</a></li> 192 <li><a href="idle.html">Idle</a></li> 193 <li><a href="i18n.html">Internationalization</a></li> 194 <li><a href="messaging.html">Message Passing</a></li> 195 <li><a href="npapi.html">NPAPI Plugins</a></li> 196 </ul> 197 </li> 198 <li>Finishing 199 <ul> 200 <li><a href="hosting.html">Hosting</a></li> 201 <li><a href="external_extensions.html">Other Deployment Options</a></li> 202 </ul> 203 </li> 204 </ul> 205 </li> 206 <li><h2><a href="apps.html">Packaged Apps</a></h2></li> 207 <li><h2><a href="tutorials.html">Tutorials</a></h2> 208 <ul> 209 <li><a href="tut_debugging.html">Debugging</a></li> 210 <li><a href="tut_analytics.html">Google Analytics</a></li> 211 <li><a href="tut_oauth.html">OAuth</a></li> 212 </ul> 213 </li> 214 <li><h2>Reference</h2> 215 <ul> 216 <li>Formats 217 <ul> 218 <li><a href="manifest.html">Manifest Files</a></li> 219 <li><a href="match_patterns.html">Match Patterns</a></li> 220 </ul> 221 </li> 222 <li><a href="permission_warnings.html">Permission Warnings</a></li> 223 <li><a href="api_index.html">chrome.* APIs</a></li> 224 <li><a href="api_other.html">Other APIs</a></li> 225 </ul> 226 </li> 227 <li><h2><a href="samples.html">Samples</a></h2></li> 228 <div class="line"> </div> 229 <li><h2>More</h2> 230 <ul> 231 <li><a href="http://code.google.com/chrome/webstore/docs/index.html">Chrome Web Store</a></li> 232 <li><a href="http://code.google.com/chrome/apps/docs/developers_guide.html">Hosted Apps</a></li> 233 <li><a href="themes.html">Themes</a></li> 234 </ul> 235 </li> 236 </ul> 237 </div> 238 <script> 239 initToggles(); 240 </script> 241 242 <div class="g-unit" id="gc-pagecontent"> 243 <div id="pageTitle"> 244 <h1 class="page_title">Context Menus</h1> 245 </div> 246 <!-- TABLE OF CONTENTS --> 247 <div id="toc"> 248 <h2>Contents</h2> 249 <ol> 250 <li> 251 <a href="#manifest">Manifest</a> 252 <ol> 253 <li style="display: none; "> 254 <a>h3Name</a> 255 </li> 256 </ol> 257 </li><li> 258 <a href="#examples">Examples</a> 259 <ol> 260 <li style="display: none; "> 261 <a>h3Name</a> 262 </li> 263 </ol> 264 </li> 265 <li> 266 <a href="#apiReference">API reference: chrome.contextMenus</a> 267 <ol> 268 <li style="display: none; "> 269 <a href="#properties">Properties</a> 270 <ol> 271 <li> 272 <a href="#property-anchor">propertyName</a> 273 </li> 274 </ol> 275 </li> 276 <li> 277 <a href="#methods">Methods</a> 278 <ol> 279 <li> 280 <a href="#method-create">create</a> 281 </li><li> 282 <a href="#method-remove">remove</a> 283 </li><li> 284 <a href="#method-removeAll">removeAll</a> 285 </li><li> 286 <a href="#method-update">update</a> 287 </li> 288 </ol> 289 </li> 290 <li style="display: none; "> 291 <a href="#events">Events</a> 292 <ol> 293 <li> 294 <a href="#event-anchor">eventName</a> 295 </li> 296 </ol> 297 </li> 298 <li> 299 <a href="#types">Types</a> 300 <ol> 301 <li> 302 <a href="#type-OnClickData">OnClickData</a> 303 </li> 304 </ol> 305 </li> 306 </ol> 307 </li> 308 </ol> 309 </div> 310 <!-- /TABLE OF CONTENTS --> 311 312 <!-- Standard content lead-in for experimental API pages --> 313 <p id="classSummary" style="display: none; "> 314 For information on how to use experimental APIs, see the <a href="experimental.html">chrome.experimental.* APIs</a> page. 315 </p> 316 317 <!-- STATIC CONTENT PLACEHOLDER --> 318 <div id="static"><div id="pageData-name" class="pageData">Context Menus</div> 319 320<!-- BEGIN AUTHORED CONTENT --> 321<p> 322The context menus module allows you 323to add items to Google Chrome's context menu. 324</p> 325 326<p> 327You can choose what types of objects 328your context menu additions apply to, 329such as images, hyperlinks, and pages. 330</p> 331 332<p> 333You can create as many context menu items 334as you need, but if more than one 335from your extension is visible at once, 336Google Chrome automatically collapses them 337into a single parent menu. 338</p> 339 340<h2 id="manifest">Manifest</h2> 341<p>You must declare the "contextMenus" permission 342in your extension's manifest to use the API. 343Also, you should specify a 16x16-pixel icon 344for display next to your menu item. 345For example: 346</p> 347 348<pre>{ 349 "name": "My extension", 350 ... 351 "permissions": [ 352 <b>"contextMenus"</b> 353 ], 354 "icons": { 355 <b>"16": "icon-bitty.png",</b> 356 "48": "icon-small.png", 357 "128": "icon-large.png" 358 }, 359 ... 360}</pre> 361 362<h2 id="examples">Examples</h2> 363 364<p> 365You can find samples of this API on the 366<a href="samples.html#contextMenus">sample page</a>. 367 368<!-- END AUTHORED CONTENT --> 369</p></div> 370 371 <!-- API PAGE --> 372 <div class="apiPage"> 373 <a name="apiReference"></a> 374 <h2>API reference: chrome.contextMenus</h2> 375 376 <!-- PROPERTIES --> 377 <div class="apiGroup" style="display: none; "> 378 <a name="properties"></a> 379 <h3 id="properties">Properties</h3> 380 381 <div> 382 <a></a> 383 <h4>getLastError</h4> 384 <div class="summary"> 385 <!-- Note: intentionally longer 80 columns --> 386 <span>chrome.extension</span><span>lastError</span> 387 </div> 388 <div> 389 </div> 390 </div> 391 392 </div> <!-- /apiGroup --> 393 394 <!-- METHODS --> 395 <div class="apiGroup" id="methods"> 396 <a name="methods"></a> 397 <h3>Methods</h3> 398 399 <!-- iterates over all functions --> 400 <div class="apiItem"> 401 <a name="method-create"></a> <!-- method-anchor --> 402 <h4>create</h4> 403 404 <div class="summary"><span>integer</span> 405 <!-- Note: intentionally longer 80 columns --> 406 <span>chrome.contextMenus.create</span>(<span class="null"><span style="display: none; ">, </span><span>object</span> 407 <var><span>createProperties</span></var></span><span class="optional"><span>, </span><span>function</span> 408 <var><span>callback</span></var></span>)</div> 409 410 <div class="description"> 411 <p class="todo" style="display: none; ">Undocumented.</p> 412 <p>Creates a new context menu item. Note that if an error occurs during creation, you may not find out until the creation callback fires (the details will be in chrome.extension.lastError).</p> 413 414 <!-- PARAMETERS --> 415 <h4>Parameters</h4> 416 <dl> 417 <div> 418 <div> 419 <dt> 420 <var>createProperties</var> 421 <em> 422 423 <!-- TYPE --> 424 <div style="display:inline"> 425 ( 426 <span class="optional" style="display: none; ">optional</span> 427 <span class="enum" style="display: none; ">enumerated</span> 428 <span id="typeTemplate"> 429 <span style="display: none; "> 430 <a> Type</a> 431 </span> 432 <span> 433 <span style="display: none; "> 434 array of <span><span></span></span> 435 </span> 436 <span>object</span> 437 <span style="display: none; "></span> 438 </span> 439 </span> 440 ) 441 </div> 442 443 </em> 444 </dt> 445 <dd class="todo"> 446 Undocumented. 447 </dd> 448 <dd style="display: none; "> 449 Description of this parameter from the json schema. 450 </dd> 451 <dd style="display: none; "> 452 This parameter was added in version 453 <b><span></span></b>. 454 You must omit this parameter in earlier versions, 455 and you may omit it in any version. If you require this 456 parameter, the manifest key 457 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 458 can ensure that your extension won't be run in an earlier browser version. 459 </dd> 460 461 <!-- OBJECT PROPERTIES --> 462 <dd> 463 <dl> 464 <div> 465 <div> 466 <dt> 467 <var>type</var> 468 <em> 469 470 <!-- TYPE --> 471 <div style="display:inline"> 472 ( 473 <span class="optional">optional</span> 474 <span class="enum" style="display: none; ">enumerated</span> 475 <span id="typeTemplate"> 476 <span style="display: none; "> 477 <a> Type</a> 478 </span> 479 <span> 480 <span style="display: none; "> 481 array of <span><span></span></span> 482 </span> 483 <span>string</span> 484 <span style="display: none; "></span> 485 </span> 486 </span> 487 ) 488 </div> 489 490 </em> 491 </dt> 492 <dd class="todo" style="display: none; "> 493 Undocumented. 494 </dd> 495 <dd>The type of menu item - one of 'normal', 'checkbox', 'radio', or 'separator'. Defaults to 'normal' if not specified.</dd> 496 <dd style="display: none; "> 497 This parameter was added in version 498 <b><span></span></b>. 499 You must omit this parameter in earlier versions, 500 and you may omit it in any version. If you require this 501 parameter, the manifest key 502 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 503 can ensure that your extension won't be run in an earlier browser version. 504 </dd> 505 506 <!-- OBJECT PROPERTIES --> 507 <dd style="display: none; "> 508 <dl> 509 <div> 510 <div> 511 </div> 512 </div> 513 </dl> 514 </dd> 515 516 <!-- FUNCTION PARAMETERS --> 517 <dd style="display: none; "> 518 <div></div> 519 </dd> 520 521 </div> 522 </div><div> 523 <div> 524 <dt> 525 <var>title</var> 526 <em> 527 528 <!-- TYPE --> 529 <div style="display:inline"> 530 ( 531 <span class="optional">optional</span> 532 <span class="enum" style="display: none; ">enumerated</span> 533 <span id="typeTemplate"> 534 <span style="display: none; "> 535 <a> Type</a> 536 </span> 537 <span> 538 <span style="display: none; "> 539 array of <span><span></span></span> 540 </span> 541 <span>string</span> 542 <span style="display: none; "></span> 543 </span> 544 </span> 545 ) 546 </div> 547 548 </em> 549 </dt> 550 <dd class="todo" style="display: none; "> 551 Undocumented. 552 </dd> 553 <dd>The text to be displayed in the item; this is <em>required</em> unless <em>type</em> is 'separator'. When the context is 'selection', you can use <code>%s</code> within the string to show the selected text. For example, if this parameter's value is "Translate '%s' to Pig Latin" and the user selects the word "cool", the context menu item for the selection is "Translate 'cool' to Pig Latin".</dd> 554 <dd style="display: none; "> 555 This parameter was added in version 556 <b><span></span></b>. 557 You must omit this parameter in earlier versions, 558 and you may omit it in any version. If you require this 559 parameter, the manifest key 560 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 561 can ensure that your extension won't be run in an earlier browser version. 562 </dd> 563 564 <!-- OBJECT PROPERTIES --> 565 <dd style="display: none; "> 566 <dl> 567 <div> 568 <div> 569 </div> 570 </div> 571 </dl> 572 </dd> 573 574 <!-- FUNCTION PARAMETERS --> 575 <dd style="display: none; "> 576 <div></div> 577 </dd> 578 579 </div> 580 </div><div> 581 <div> 582 <dt> 583 <var>checked</var> 584 <em> 585 586 <!-- TYPE --> 587 <div style="display:inline"> 588 ( 589 <span class="optional">optional</span> 590 <span class="enum" style="display: none; ">enumerated</span> 591 <span id="typeTemplate"> 592 <span style="display: none; "> 593 <a> Type</a> 594 </span> 595 <span> 596 <span style="display: none; "> 597 array of <span><span></span></span> 598 </span> 599 <span>boolean</span> 600 <span style="display: none; "></span> 601 </span> 602 </span> 603 ) 604 </div> 605 606 </em> 607 </dt> 608 <dd class="todo" style="display: none; "> 609 Undocumented. 610 </dd> 611 <dd>The initial state of a checkbox or radio item: true for selected and false for unselected. Only one radio item can be selected at a time in a given group of radio items.</dd> 612 <dd style="display: none; "> 613 This parameter was added in version 614 <b><span></span></b>. 615 You must omit this parameter in earlier versions, 616 and you may omit it in any version. If you require this 617 parameter, the manifest key 618 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 619 can ensure that your extension won't be run in an earlier browser version. 620 </dd> 621 622 <!-- OBJECT PROPERTIES --> 623 <dd style="display: none; "> 624 <dl> 625 <div> 626 <div> 627 </div> 628 </div> 629 </dl> 630 </dd> 631 632 <!-- FUNCTION PARAMETERS --> 633 <dd style="display: none; "> 634 <div></div> 635 </dd> 636 637 </div> 638 </div><div> 639 <div> 640 <dt> 641 <var>contexts</var> 642 <em> 643 644 <!-- TYPE --> 645 <div style="display:inline"> 646 ( 647 <span class="optional">optional</span> 648 <span class="enum" style="display: none; ">enumerated</span> 649 <span id="typeTemplate"> 650 <span style="display: none; "> 651 <a> Type</a> 652 </span> 653 <span> 654 <span> 655 array of <span><span> 656 <span style="display: none; "> 657 <a> Type</a> 658 </span> 659 <span> 660 <span style="display: none; "> 661 array of <span><span></span></span> 662 </span> 663 <span>string</span> 664 <span style="display: none; "></span> 665 </span> 666 </span></span> 667 </span> 668 <span style="display: none; ">paramType</span> 669 <span style="display: none; "></span> 670 </span> 671 </span> 672 ) 673 </div> 674 675 </em> 676 </dt> 677 <dd class="todo" style="display: none; "> 678 Undocumented. 679 </dd> 680 <dd>List of contexts this menu item will appear in. Legal values are: 'all', 'page', 'selection', 'link', 'editable', 'image', 'video', and 'audio'. Defaults to ['page'].</dd> 681 <dd style="display: none; "> 682 This parameter was added in version 683 <b><span></span></b>. 684 You must omit this parameter in earlier versions, 685 and you may omit it in any version. If you require this 686 parameter, the manifest key 687 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 688 can ensure that your extension won't be run in an earlier browser version. 689 </dd> 690 691 <!-- OBJECT PROPERTIES --> 692 <dd style="display: none; "> 693 <dl> 694 <div> 695 <div> 696 </div> 697 </div> 698 </dl> 699 </dd> 700 701 <!-- FUNCTION PARAMETERS --> 702 <dd style="display: none; "> 703 <div></div> 704 </dd> 705 706 </div> 707 </div><div> 708 <div> 709 <dt> 710 <var>onclick</var> 711 <em> 712 713 <!-- TYPE --> 714 <div style="display:inline"> 715 ( 716 <span class="optional">optional</span> 717 <span class="enum" style="display: none; ">enumerated</span> 718 <span id="typeTemplate"> 719 <span style="display: none; "> 720 <a> Type</a> 721 </span> 722 <span> 723 <span style="display: none; "> 724 array of <span><span></span></span> 725 </span> 726 <span>function</span> 727 <span style="display: none; "></span> 728 </span> 729 </span> 730 ) 731 </div> 732 733 </em> 734 </dt> 735 <dd class="todo" style="display: none; "> 736 Undocumented. 737 </dd> 738 <dd>A function that will be called back when the menu item is clicked.</dd> 739 <dd style="display: none; "> 740 This parameter was added in version 741 <b><span></span></b>. 742 You must omit this parameter in earlier versions, 743 and you may omit it in any version. If you require this 744 parameter, the manifest key 745 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 746 can ensure that your extension won't be run in an earlier browser version. 747 </dd> 748 749 <!-- OBJECT PROPERTIES --> 750 <dd style="display: none; "> 751 <dl> 752 <div> 753 <div> 754 </div> 755 </div> 756 </dl> 757 </dd> 758 759 <!-- FUNCTION PARAMETERS --> 760 <dd> 761 <div> 762 <h5>Parameters</h5> 763 <dl> 764 <div> 765 <div> 766 <dt> 767 <var>info</var> 768 <em> 769 770 <!-- TYPE --> 771 <div style="display:inline"> 772 ( 773 <span class="optional" style="display: none; ">optional</span> 774 <span class="enum" style="display: none; ">enumerated</span> 775 <span id="typeTemplate"> 776 <span> 777 <a href="contextMenus.html#type-OnClickData">OnClickData</a> 778 </span> 779 <span style="display: none; "> 780 <span> 781 array of <span><span></span></span> 782 </span> 783 <span>paramType</span> 784 <span></span> 785 </span> 786 </span> 787 ) 788 </div> 789 790 </em> 791 </dt> 792 <dd class="todo" style="display: none; "> 793 Undocumented. 794 </dd> 795 <dd>Information about the item clicked and the context where the click happened.</dd> 796 <dd style="display: none; "> 797 This parameter was added in version 798 <b><span></span></b>. 799 You must omit this parameter in earlier versions, 800 and you may omit it in any version. If you require this 801 parameter, the manifest key 802 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 803 can ensure that your extension won't be run in an earlier browser version. 804 </dd> 805 806 <!-- OBJECT PROPERTIES --> 807 <dd style="display: none; "> 808 <dl> 809 <div> 810 <div> 811 </div> 812 </div> 813 </dl> 814 </dd> 815 816 <!-- FUNCTION PARAMETERS --> 817 <dd style="display: none; "> 818 <div></div> 819 </dd> 820 821 </div> 822 </div><div> 823 <div> 824 <dt> 825 <var>tab</var> 826 <em> 827 828 <!-- TYPE --> 829 <div style="display:inline"> 830 ( 831 <span class="optional" style="display: none; ">optional</span> 832 <span class="enum" style="display: none; ">enumerated</span> 833 <span id="typeTemplate"> 834 <span> 835 <a href="tabs.html#type-Tab">Tab</a> 836 </span> 837 <span style="display: none; "> 838 <span> 839 array of <span><span></span></span> 840 </span> 841 <span>paramType</span> 842 <span></span> 843 </span> 844 </span> 845 ) 846 </div> 847 848 </em> 849 </dt> 850 <dd class="todo" style="display: none; "> 851 Undocumented. 852 </dd> 853 <dd>The details of the tab where the click took place.</dd> 854 <dd style="display: none; "> 855 This parameter was added in version 856 <b><span></span></b>. 857 You must omit this parameter in earlier versions, 858 and you may omit it in any version. If you require this 859 parameter, the manifest key 860 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 861 can ensure that your extension won't be run in an earlier browser version. 862 </dd> 863 864 <!-- OBJECT PROPERTIES --> 865 <dd style="display: none; "> 866 <dl> 867 <div> 868 <div> 869 </div> 870 </div> 871 </dl> 872 </dd> 873 874 <!-- FUNCTION PARAMETERS --> 875 <dd style="display: none; "> 876 <div></div> 877 </dd> 878 879 </div> 880 </div> 881 </dl> 882 </div> 883 </dd> 884 885 </div> 886 </div><div> 887 <div> 888 <dt> 889 <var>parentId</var> 890 <em> 891 892 <!-- TYPE --> 893 <div style="display:inline"> 894 ( 895 <span class="optional">optional</span> 896 <span class="enum" style="display: none; ">enumerated</span> 897 <span id="typeTemplate"> 898 <span style="display: none; "> 899 <a> Type</a> 900 </span> 901 <span> 902 <span style="display: none; "> 903 array of <span><span></span></span> 904 </span> 905 <span>integer</span> 906 <span style="display: none; "></span> 907 </span> 908 </span> 909 ) 910 </div> 911 912 </em> 913 </dt> 914 <dd class="todo" style="display: none; "> 915 Undocumented. 916 </dd> 917 <dd>The ID of a parent menu item; this makes the item a child of a previously added item.</dd> 918 <dd style="display: none; "> 919 This parameter was added in version 920 <b><span></span></b>. 921 You must omit this parameter in earlier versions, 922 and you may omit it in any version. If you require this 923 parameter, the manifest key 924 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 925 can ensure that your extension won't be run in an earlier browser version. 926 </dd> 927 928 <!-- OBJECT PROPERTIES --> 929 <dd style="display: none; "> 930 <dl> 931 <div> 932 <div> 933 </div> 934 </div> 935 </dl> 936 </dd> 937 938 <!-- FUNCTION PARAMETERS --> 939 <dd style="display: none; "> 940 <div></div> 941 </dd> 942 943 </div> 944 </div><div> 945 <div> 946 <dt> 947 <var>documentUrlPatterns</var> 948 <em> 949 950 <!-- TYPE --> 951 <div style="display:inline"> 952 ( 953 <span class="optional">optional</span> 954 <span class="enum" style="display: none; ">enumerated</span> 955 <span id="typeTemplate"> 956 <span style="display: none; "> 957 <a> Type</a> 958 </span> 959 <span> 960 <span> 961 array of <span><span> 962 <span style="display: none; "> 963 <a> Type</a> 964 </span> 965 <span> 966 <span style="display: none; "> 967 array of <span><span></span></span> 968 </span> 969 <span>string</span> 970 <span style="display: none; "></span> 971 </span> 972 </span></span> 973 </span> 974 <span style="display: none; ">paramType</span> 975 <span style="display: none; "></span> 976 </span> 977 </span> 978 ) 979 </div> 980 981 </em> 982 </dt> 983 <dd class="todo" style="display: none; "> 984 Undocumented. 985 </dd> 986 <dd>Lets you restrict the item to apply only to documents whose URL matches one of the given patterns. (This applies to frames as well.) For details on the format of a pattern, see <a href="match_patterns.html">Match Patterns</a>.</dd> 987 <dd style="display: none; "> 988 This parameter was added in version 989 <b><span></span></b>. 990 You must omit this parameter in earlier versions, 991 and you may omit it in any version. If you require this 992 parameter, the manifest key 993 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 994 can ensure that your extension won't be run in an earlier browser version. 995 </dd> 996 997 <!-- OBJECT PROPERTIES --> 998 <dd style="display: none; "> 999 <dl> 1000 <div> 1001 <div> 1002 </div> 1003 </div> 1004 </dl> 1005 </dd> 1006 1007 <!-- FUNCTION PARAMETERS --> 1008 <dd style="display: none; "> 1009 <div></div> 1010 </dd> 1011 1012 </div> 1013 </div><div> 1014 <div> 1015 <dt> 1016 <var>targetUrlPatterns</var> 1017 <em> 1018 1019 <!-- TYPE --> 1020 <div style="display:inline"> 1021 ( 1022 <span class="optional">optional</span> 1023 <span class="enum" style="display: none; ">enumerated</span> 1024 <span id="typeTemplate"> 1025 <span style="display: none; "> 1026 <a> Type</a> 1027 </span> 1028 <span> 1029 <span> 1030 array of <span><span> 1031 <span style="display: none; "> 1032 <a> Type</a> 1033 </span> 1034 <span> 1035 <span style="display: none; "> 1036 array of <span><span></span></span> 1037 </span> 1038 <span>string</span> 1039 <span style="display: none; "></span> 1040 </span> 1041 </span></span> 1042 </span> 1043 <span style="display: none; ">paramType</span> 1044 <span style="display: none; "></span> 1045 </span> 1046 </span> 1047 ) 1048 </div> 1049 1050 </em> 1051 </dt> 1052 <dd class="todo" style="display: none; "> 1053 Undocumented. 1054 </dd> 1055 <dd>Similar to documentUrlPatterns, but lets you filter based on the src attribute of img/audio/video tags and the href of anchor tags.</dd> 1056 <dd style="display: none; "> 1057 This parameter was added in version 1058 <b><span></span></b>. 1059 You must omit this parameter in earlier versions, 1060 and you may omit it in any version. If you require this 1061 parameter, the manifest key 1062 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1063 can ensure that your extension won't be run in an earlier browser version. 1064 </dd> 1065 1066 <!-- OBJECT PROPERTIES --> 1067 <dd style="display: none; "> 1068 <dl> 1069 <div> 1070 <div> 1071 </div> 1072 </div> 1073 </dl> 1074 </dd> 1075 1076 <!-- FUNCTION PARAMETERS --> 1077 <dd style="display: none; "> 1078 <div></div> 1079 </dd> 1080 1081 </div> 1082 </div> 1083 </dl> 1084 </dd> 1085 1086 <!-- FUNCTION PARAMETERS --> 1087 <dd style="display: none; "> 1088 <div></div> 1089 </dd> 1090 1091 </div> 1092 </div><div> 1093 <div> 1094 <dt> 1095 <var>callback</var> 1096 <em> 1097 1098 <!-- TYPE --> 1099 <div style="display:inline"> 1100 ( 1101 <span class="optional">optional</span> 1102 <span class="enum" style="display: none; ">enumerated</span> 1103 <span id="typeTemplate"> 1104 <span style="display: none; "> 1105 <a> Type</a> 1106 </span> 1107 <span> 1108 <span style="display: none; "> 1109 array of <span><span></span></span> 1110 </span> 1111 <span>function</span> 1112 <span style="display: none; "></span> 1113 </span> 1114 </span> 1115 ) 1116 </div> 1117 1118 </em> 1119 </dt> 1120 <dd class="todo" style="display: none; "> 1121 Undocumented. 1122 </dd> 1123 <dd>Called when the item has been created in the browser. If there were any problems creating the item, details will be available in chrome.extension.lastError.</dd> 1124 <dd style="display: none; "> 1125 This parameter was added in version 1126 <b><span></span></b>. 1127 You must omit this parameter in earlier versions, 1128 and you may omit it in any version. If you require this 1129 parameter, the manifest key 1130 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1131 can ensure that your extension won't be run in an earlier browser version. 1132 </dd> 1133 1134 <!-- OBJECT PROPERTIES --> 1135 <dd style="display: none; "> 1136 <dl> 1137 <div> 1138 <div> 1139 </div> 1140 </div> 1141 </dl> 1142 </dd> 1143 1144 <!-- FUNCTION PARAMETERS --> 1145 <dd style="display: none; "> 1146 <div></div> 1147 </dd> 1148 1149 </div> 1150 </div> 1151 </dl> 1152 1153 <!-- RETURNS --> 1154 <h4>Returns</h4> 1155 <dl> 1156 <div> 1157 <div> 1158 <dt> 1159 <var style="display: none; ">paramName</var> 1160 <em> 1161 1162 <!-- TYPE --> 1163 <div style="display:inline"> 1164 ( 1165 <span class="optional" style="display: none; ">optional</span> 1166 <span class="enum" style="display: none; ">enumerated</span> 1167 <span id="typeTemplate"> 1168 <span style="display: none; "> 1169 <a> Type</a> 1170 </span> 1171 <span> 1172 <span style="display: none; "> 1173 array of <span><span></span></span> 1174 </span> 1175 <span>integer</span> 1176 <span style="display: none; "></span> 1177 </span> 1178 </span> 1179 ) 1180 </div> 1181 1182 </em> 1183 </dt> 1184 <dd class="todo" style="display: none; "> 1185 Undocumented. 1186 </dd> 1187 <dd>The ID of the newly created item.</dd> 1188 <dd style="display: none; "> 1189 This parameter was added in version 1190 <b><span></span></b>. 1191 You must omit this parameter in earlier versions, 1192 and you may omit it in any version. If you require this 1193 parameter, the manifest key 1194 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1195 can ensure that your extension won't be run in an earlier browser version. 1196 </dd> 1197 1198 <!-- OBJECT PROPERTIES --> 1199 <dd style="display: none; "> 1200 <dl> 1201 <div> 1202 <div> 1203 </div> 1204 </div> 1205 </dl> 1206 </dd> 1207 1208 <!-- FUNCTION PARAMETERS --> 1209 <dd style="display: none; "> 1210 <div></div> 1211 </dd> 1212 1213 </div> 1214 </div> 1215 </dl> 1216 1217 <!-- CALLBACK --> 1218 <div> 1219 <div> 1220 <h4>Callback function</h4> 1221 <p style="display: none; "> 1222 The callback <em>parameter</em> should specify a function 1223 that looks like this: 1224 </p> 1225 <p> 1226 If you specify the <em>callback</em> parameter, it should 1227 specify a function that looks like this: 1228 </p> 1229 1230 <!-- Note: intentionally longer 80 columns --> 1231 <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre> 1232 <dl> 1233 <div style="display: none; "> 1234 <div> 1235 </div> 1236 </div> 1237 </dl> 1238 </div> 1239 </div> 1240 1241 <!-- MIN_VERSION --> 1242 <p style="display: none; "> 1243 This function was added in version <b><span></span></b>. 1244 If you require this function, the manifest key 1245 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1246 can ensure that your extension won't be run in an earlier browser version. 1247 </p> 1248 </div> <!-- /description --> 1249 1250 </div><div class="apiItem"> 1251 <a name="method-remove"></a> <!-- method-anchor --> 1252 <h4>remove</h4> 1253 1254 <div class="summary"><span style="display: none; ">void</span> 1255 <!-- Note: intentionally longer 80 columns --> 1256 <span>chrome.contextMenus.remove</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> 1257 <var><span>menuItemId</span></var></span><span class="optional"><span>, </span><span>function</span> 1258 <var><span>callback</span></var></span>)</div> 1259 1260 <div class="description"> 1261 <p class="todo" style="display: none; ">Undocumented.</p> 1262 <p>Remove a context menu item.</p> 1263 1264 <!-- PARAMETERS --> 1265 <h4>Parameters</h4> 1266 <dl> 1267 <div> 1268 <div> 1269 <dt> 1270 <var>menuItemId</var> 1271 <em> 1272 1273 <!-- TYPE --> 1274 <div style="display:inline"> 1275 ( 1276 <span class="optional" style="display: none; ">optional</span> 1277 <span class="enum" style="display: none; ">enumerated</span> 1278 <span id="typeTemplate"> 1279 <span style="display: none; "> 1280 <a> Type</a> 1281 </span> 1282 <span> 1283 <span style="display: none; "> 1284 array of <span><span></span></span> 1285 </span> 1286 <span>integer</span> 1287 <span style="display: none; "></span> 1288 </span> 1289 </span> 1290 ) 1291 </div> 1292 1293 </em> 1294 </dt> 1295 <dd class="todo" style="display: none; "> 1296 Undocumented. 1297 </dd> 1298 <dd>The ID of the context menu item to remove.</dd> 1299 <dd style="display: none; "> 1300 This parameter was added in version 1301 <b><span></span></b>. 1302 You must omit this parameter in earlier versions, 1303 and you may omit it in any version. If you require this 1304 parameter, the manifest key 1305 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1306 can ensure that your extension won't be run in an earlier browser version. 1307 </dd> 1308 1309 <!-- OBJECT PROPERTIES --> 1310 <dd style="display: none; "> 1311 <dl> 1312 <div> 1313 <div> 1314 </div> 1315 </div> 1316 </dl> 1317 </dd> 1318 1319 <!-- FUNCTION PARAMETERS --> 1320 <dd style="display: none; "> 1321 <div></div> 1322 </dd> 1323 1324 </div> 1325 </div><div> 1326 <div> 1327 <dt> 1328 <var>callback</var> 1329 <em> 1330 1331 <!-- TYPE --> 1332 <div style="display:inline"> 1333 ( 1334 <span class="optional">optional</span> 1335 <span class="enum" style="display: none; ">enumerated</span> 1336 <span id="typeTemplate"> 1337 <span style="display: none; "> 1338 <a> Type</a> 1339 </span> 1340 <span> 1341 <span style="display: none; "> 1342 array of <span><span></span></span> 1343 </span> 1344 <span>function</span> 1345 <span style="display: none; "></span> 1346 </span> 1347 </span> 1348 ) 1349 </div> 1350 1351 </em> 1352 </dt> 1353 <dd class="todo" style="display: none; "> 1354 Undocumented. 1355 </dd> 1356 <dd>Called when the context menu has been removed.</dd> 1357 <dd style="display: none; "> 1358 This parameter was added in version 1359 <b><span></span></b>. 1360 You must omit this parameter in earlier versions, 1361 and you may omit it in any version. If you require this 1362 parameter, the manifest key 1363 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1364 can ensure that your extension won't be run in an earlier browser version. 1365 </dd> 1366 1367 <!-- OBJECT PROPERTIES --> 1368 <dd style="display: none; "> 1369 <dl> 1370 <div> 1371 <div> 1372 </div> 1373 </div> 1374 </dl> 1375 </dd> 1376 1377 <!-- FUNCTION PARAMETERS --> 1378 <dd style="display: none; "> 1379 <div></div> 1380 </dd> 1381 1382 </div> 1383 </div> 1384 </dl> 1385 1386 <!-- RETURNS --> 1387 <h4 style="display: none; ">Returns</h4> 1388 <dl> 1389 <div style="display: none; "> 1390 <div> 1391 </div> 1392 </div> 1393 </dl> 1394 1395 <!-- CALLBACK --> 1396 <div> 1397 <div> 1398 <h4>Callback function</h4> 1399 <p style="display: none; "> 1400 The callback <em>parameter</em> should specify a function 1401 that looks like this: 1402 </p> 1403 <p> 1404 If you specify the <em>callback</em> parameter, it should 1405 specify a function that looks like this: 1406 </p> 1407 1408 <!-- Note: intentionally longer 80 columns --> 1409 <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre> 1410 <dl> 1411 <div style="display: none; "> 1412 <div> 1413 </div> 1414 </div> 1415 </dl> 1416 </div> 1417 </div> 1418 1419 <!-- MIN_VERSION --> 1420 <p style="display: none; "> 1421 This function was added in version <b><span></span></b>. 1422 If you require this function, the manifest key 1423 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1424 can ensure that your extension won't be run in an earlier browser version. 1425 </p> 1426 </div> <!-- /description --> 1427 1428 </div><div class="apiItem"> 1429 <a name="method-removeAll"></a> <!-- method-anchor --> 1430 <h4>removeAll</h4> 1431 1432 <div class="summary"><span style="display: none; ">void</span> 1433 <!-- Note: intentionally longer 80 columns --> 1434 <span>chrome.contextMenus.removeAll</span>(<span class="optional"><span style="display: none; ">, </span><span>function</span> 1435 <var><span>callback</span></var></span>)</div> 1436 1437 <div class="description"> 1438 <p class="todo" style="display: none; ">Undocumented.</p> 1439 <p>Remove all context menu items added by this extension.</p> 1440 1441 <!-- PARAMETERS --> 1442 <h4>Parameters</h4> 1443 <dl> 1444 <div> 1445 <div> 1446 <dt> 1447 <var>callback</var> 1448 <em> 1449 1450 <!-- TYPE --> 1451 <div style="display:inline"> 1452 ( 1453 <span class="optional">optional</span> 1454 <span class="enum" style="display: none; ">enumerated</span> 1455 <span id="typeTemplate"> 1456 <span style="display: none; "> 1457 <a> Type</a> 1458 </span> 1459 <span> 1460 <span style="display: none; "> 1461 array of <span><span></span></span> 1462 </span> 1463 <span>function</span> 1464 <span style="display: none; "></span> 1465 </span> 1466 </span> 1467 ) 1468 </div> 1469 1470 </em> 1471 </dt> 1472 <dd class="todo" style="display: none; "> 1473 Undocumented. 1474 </dd> 1475 <dd>Called when removal is complete.</dd> 1476 <dd style="display: none; "> 1477 This parameter was added in version 1478 <b><span></span></b>. 1479 You must omit this parameter in earlier versions, 1480 and you may omit it in any version. If you require this 1481 parameter, the manifest key 1482 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1483 can ensure that your extension won't be run in an earlier browser version. 1484 </dd> 1485 1486 <!-- OBJECT PROPERTIES --> 1487 <dd style="display: none; "> 1488 <dl> 1489 <div> 1490 <div> 1491 </div> 1492 </div> 1493 </dl> 1494 </dd> 1495 1496 <!-- FUNCTION PARAMETERS --> 1497 <dd style="display: none; "> 1498 <div></div> 1499 </dd> 1500 1501 </div> 1502 </div> 1503 </dl> 1504 1505 <!-- RETURNS --> 1506 <h4 style="display: none; ">Returns</h4> 1507 <dl> 1508 <div style="display: none; "> 1509 <div> 1510 </div> 1511 </div> 1512 </dl> 1513 1514 <!-- CALLBACK --> 1515 <div> 1516 <div> 1517 <h4>Callback function</h4> 1518 <p style="display: none; "> 1519 The callback <em>parameter</em> should specify a function 1520 that looks like this: 1521 </p> 1522 <p> 1523 If you specify the <em>callback</em> parameter, it should 1524 specify a function that looks like this: 1525 </p> 1526 1527 <!-- Note: intentionally longer 80 columns --> 1528 <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre> 1529 <dl> 1530 <div style="display: none; "> 1531 <div> 1532 </div> 1533 </div> 1534 </dl> 1535 </div> 1536 </div> 1537 1538 <!-- MIN_VERSION --> 1539 <p style="display: none; "> 1540 This function was added in version <b><span></span></b>. 1541 If you require this function, the manifest key 1542 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1543 can ensure that your extension won't be run in an earlier browser version. 1544 </p> 1545 </div> <!-- /description --> 1546 1547 </div><div class="apiItem"> 1548 <a name="method-update"></a> <!-- method-anchor --> 1549 <h4>update</h4> 1550 1551 <div class="summary"><span style="display: none; ">void</span> 1552 <!-- Note: intentionally longer 80 columns --> 1553 <span>chrome.contextMenus.update</span>(<span class="null"><span style="display: none; ">, </span><span>integer</span> 1554 <var><span>id</span></var></span><span class="null"><span>, </span><span>object</span> 1555 <var><span>updateProperties</span></var></span><span class="optional"><span>, </span><span>function</span> 1556 <var><span>callback</span></var></span>)</div> 1557 1558 <div class="description"> 1559 <p class="todo" style="display: none; ">Undocumented.</p> 1560 <p>Update a previously created context menu item.</p> 1561 1562 <!-- PARAMETERS --> 1563 <h4>Parameters</h4> 1564 <dl> 1565 <div> 1566 <div> 1567 <dt> 1568 <var>id</var> 1569 <em> 1570 1571 <!-- TYPE --> 1572 <div style="display:inline"> 1573 ( 1574 <span class="optional" style="display: none; ">optional</span> 1575 <span class="enum" style="display: none; ">enumerated</span> 1576 <span id="typeTemplate"> 1577 <span style="display: none; "> 1578 <a> Type</a> 1579 </span> 1580 <span> 1581 <span style="display: none; "> 1582 array of <span><span></span></span> 1583 </span> 1584 <span>integer</span> 1585 <span style="display: none; "></span> 1586 </span> 1587 </span> 1588 ) 1589 </div> 1590 1591 </em> 1592 </dt> 1593 <dd class="todo" style="display: none; "> 1594 Undocumented. 1595 </dd> 1596 <dd>The ID of the item to update.</dd> 1597 <dd style="display: none; "> 1598 This parameter was added in version 1599 <b><span></span></b>. 1600 You must omit this parameter in earlier versions, 1601 and you may omit it in any version. If you require this 1602 parameter, the manifest key 1603 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1604 can ensure that your extension won't be run in an earlier browser version. 1605 </dd> 1606 1607 <!-- OBJECT PROPERTIES --> 1608 <dd style="display: none; "> 1609 <dl> 1610 <div> 1611 <div> 1612 </div> 1613 </div> 1614 </dl> 1615 </dd> 1616 1617 <!-- FUNCTION PARAMETERS --> 1618 <dd style="display: none; "> 1619 <div></div> 1620 </dd> 1621 1622 </div> 1623 </div><div> 1624 <div> 1625 <dt> 1626 <var>updateProperties</var> 1627 <em> 1628 1629 <!-- TYPE --> 1630 <div style="display:inline"> 1631 ( 1632 <span class="optional" style="display: none; ">optional</span> 1633 <span class="enum" style="display: none; ">enumerated</span> 1634 <span id="typeTemplate"> 1635 <span style="display: none; "> 1636 <a> Type</a> 1637 </span> 1638 <span> 1639 <span style="display: none; "> 1640 array of <span><span></span></span> 1641 </span> 1642 <span>object</span> 1643 <span style="display: none; "></span> 1644 </span> 1645 </span> 1646 ) 1647 </div> 1648 1649 </em> 1650 </dt> 1651 <dd class="todo" style="display: none; "> 1652 Undocumented. 1653 </dd> 1654 <dd>The properties to update. Accepts the same values as the create function.</dd> 1655 <dd style="display: none; "> 1656 This parameter was added in version 1657 <b><span></span></b>. 1658 You must omit this parameter in earlier versions, 1659 and you may omit it in any version. If you require this 1660 parameter, the manifest key 1661 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1662 can ensure that your extension won't be run in an earlier browser version. 1663 </dd> 1664 1665 <!-- OBJECT PROPERTIES --> 1666 <dd> 1667 <dl> 1668 <div> 1669 <div> 1670 <dt> 1671 <var>type</var> 1672 <em> 1673 1674 <!-- TYPE --> 1675 <div style="display:inline"> 1676 ( 1677 <span class="optional">optional</span> 1678 <span class="enum" style="display: none; ">enumerated</span> 1679 <span id="typeTemplate"> 1680 <span style="display: none; "> 1681 <a> Type</a> 1682 </span> 1683 <span> 1684 <span style="display: none; "> 1685 array of <span><span></span></span> 1686 </span> 1687 <span>string</span> 1688 <span style="display: none; "></span> 1689 </span> 1690 </span> 1691 ) 1692 </div> 1693 1694 </em> 1695 </dt> 1696 <dd class="todo"> 1697 Undocumented. 1698 </dd> 1699 <dd style="display: none; "> 1700 Description of this parameter from the json schema. 1701 </dd> 1702 <dd style="display: none; "> 1703 This parameter was added in version 1704 <b><span></span></b>. 1705 You must omit this parameter in earlier versions, 1706 and you may omit it in any version. If you require this 1707 parameter, the manifest key 1708 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1709 can ensure that your extension won't be run in an earlier browser version. 1710 </dd> 1711 1712 <!-- OBJECT PROPERTIES --> 1713 <dd style="display: none; "> 1714 <dl> 1715 <div> 1716 <div> 1717 </div> 1718 </div> 1719 </dl> 1720 </dd> 1721 1722 <!-- FUNCTION PARAMETERS --> 1723 <dd style="display: none; "> 1724 <div></div> 1725 </dd> 1726 1727 </div> 1728 </div><div> 1729 <div> 1730 <dt> 1731 <var>title</var> 1732 <em> 1733 1734 <!-- TYPE --> 1735 <div style="display:inline"> 1736 ( 1737 <span class="optional">optional</span> 1738 <span class="enum" style="display: none; ">enumerated</span> 1739 <span id="typeTemplate"> 1740 <span style="display: none; "> 1741 <a> Type</a> 1742 </span> 1743 <span> 1744 <span style="display: none; "> 1745 array of <span><span></span></span> 1746 </span> 1747 <span>string</span> 1748 <span style="display: none; "></span> 1749 </span> 1750 </span> 1751 ) 1752 </div> 1753 1754 </em> 1755 </dt> 1756 <dd class="todo"> 1757 Undocumented. 1758 </dd> 1759 <dd style="display: none; "> 1760 Description of this parameter from the json schema. 1761 </dd> 1762 <dd style="display: none; "> 1763 This parameter was added in version 1764 <b><span></span></b>. 1765 You must omit this parameter in earlier versions, 1766 and you may omit it in any version. If you require this 1767 parameter, the manifest key 1768 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1769 can ensure that your extension won't be run in an earlier browser version. 1770 </dd> 1771 1772 <!-- OBJECT PROPERTIES --> 1773 <dd style="display: none; "> 1774 <dl> 1775 <div> 1776 <div> 1777 </div> 1778 </div> 1779 </dl> 1780 </dd> 1781 1782 <!-- FUNCTION PARAMETERS --> 1783 <dd style="display: none; "> 1784 <div></div> 1785 </dd> 1786 1787 </div> 1788 </div><div> 1789 <div> 1790 <dt> 1791 <var>checked</var> 1792 <em> 1793 1794 <!-- TYPE --> 1795 <div style="display:inline"> 1796 ( 1797 <span class="optional">optional</span> 1798 <span class="enum" style="display: none; ">enumerated</span> 1799 <span id="typeTemplate"> 1800 <span style="display: none; "> 1801 <a> Type</a> 1802 </span> 1803 <span> 1804 <span style="display: none; "> 1805 array of <span><span></span></span> 1806 </span> 1807 <span>boolean</span> 1808 <span style="display: none; "></span> 1809 </span> 1810 </span> 1811 ) 1812 </div> 1813 1814 </em> 1815 </dt> 1816 <dd class="todo"> 1817 Undocumented. 1818 </dd> 1819 <dd style="display: none; "> 1820 Description of this parameter from the json schema. 1821 </dd> 1822 <dd style="display: none; "> 1823 This parameter was added in version 1824 <b><span></span></b>. 1825 You must omit this parameter in earlier versions, 1826 and you may omit it in any version. If you require this 1827 parameter, the manifest key 1828 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1829 can ensure that your extension won't be run in an earlier browser version. 1830 </dd> 1831 1832 <!-- OBJECT PROPERTIES --> 1833 <dd style="display: none; "> 1834 <dl> 1835 <div> 1836 <div> 1837 </div> 1838 </div> 1839 </dl> 1840 </dd> 1841 1842 <!-- FUNCTION PARAMETERS --> 1843 <dd style="display: none; "> 1844 <div></div> 1845 </dd> 1846 1847 </div> 1848 </div><div> 1849 <div> 1850 <dt> 1851 <var>contexts</var> 1852 <em> 1853 1854 <!-- TYPE --> 1855 <div style="display:inline"> 1856 ( 1857 <span class="optional">optional</span> 1858 <span class="enum" style="display: none; ">enumerated</span> 1859 <span id="typeTemplate"> 1860 <span style="display: none; "> 1861 <a> Type</a> 1862 </span> 1863 <span> 1864 <span> 1865 array of <span><span> 1866 <span style="display: none; "> 1867 <a> Type</a> 1868 </span> 1869 <span> 1870 <span style="display: none; "> 1871 array of <span><span></span></span> 1872 </span> 1873 <span>string</span> 1874 <span style="display: none; "></span> 1875 </span> 1876 </span></span> 1877 </span> 1878 <span style="display: none; ">paramType</span> 1879 <span style="display: none; "></span> 1880 </span> 1881 </span> 1882 ) 1883 </div> 1884 1885 </em> 1886 </dt> 1887 <dd class="todo"> 1888 Undocumented. 1889 </dd> 1890 <dd style="display: none; "> 1891 Description of this parameter from the json schema. 1892 </dd> 1893 <dd style="display: none; "> 1894 This parameter was added in version 1895 <b><span></span></b>. 1896 You must omit this parameter in earlier versions, 1897 and you may omit it in any version. If you require this 1898 parameter, the manifest key 1899 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1900 can ensure that your extension won't be run in an earlier browser version. 1901 </dd> 1902 1903 <!-- OBJECT PROPERTIES --> 1904 <dd style="display: none; "> 1905 <dl> 1906 <div> 1907 <div> 1908 </div> 1909 </div> 1910 </dl> 1911 </dd> 1912 1913 <!-- FUNCTION PARAMETERS --> 1914 <dd style="display: none; "> 1915 <div></div> 1916 </dd> 1917 1918 </div> 1919 </div><div> 1920 <div> 1921 <dt> 1922 <var>onclick</var> 1923 <em> 1924 1925 <!-- TYPE --> 1926 <div style="display:inline"> 1927 ( 1928 <span class="optional">optional</span> 1929 <span class="enum" style="display: none; ">enumerated</span> 1930 <span id="typeTemplate"> 1931 <span style="display: none; "> 1932 <a> Type</a> 1933 </span> 1934 <span> 1935 <span style="display: none; "> 1936 array of <span><span></span></span> 1937 </span> 1938 <span>function</span> 1939 <span style="display: none; "></span> 1940 </span> 1941 </span> 1942 ) 1943 </div> 1944 1945 </em> 1946 </dt> 1947 <dd class="todo"> 1948 Undocumented. 1949 </dd> 1950 <dd style="display: none; "> 1951 Description of this parameter from the json schema. 1952 </dd> 1953 <dd style="display: none; "> 1954 This parameter was added in version 1955 <b><span></span></b>. 1956 You must omit this parameter in earlier versions, 1957 and you may omit it in any version. If you require this 1958 parameter, the manifest key 1959 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 1960 can ensure that your extension won't be run in an earlier browser version. 1961 </dd> 1962 1963 <!-- OBJECT PROPERTIES --> 1964 <dd style="display: none; "> 1965 <dl> 1966 <div> 1967 <div> 1968 </div> 1969 </div> 1970 </dl> 1971 </dd> 1972 1973 <!-- FUNCTION PARAMETERS --> 1974 <dd style="display: none; "> 1975 <div></div> 1976 </dd> 1977 1978 </div> 1979 </div><div> 1980 <div> 1981 <dt> 1982 <var>parentId</var> 1983 <em> 1984 1985 <!-- TYPE --> 1986 <div style="display:inline"> 1987 ( 1988 <span class="optional">optional</span> 1989 <span class="enum" style="display: none; ">enumerated</span> 1990 <span id="typeTemplate"> 1991 <span style="display: none; "> 1992 <a> Type</a> 1993 </span> 1994 <span> 1995 <span style="display: none; "> 1996 array of <span><span></span></span> 1997 </span> 1998 <span>integer</span> 1999 <span style="display: none; "></span> 2000 </span> 2001 </span> 2002 ) 2003 </div> 2004 2005 </em> 2006 </dt> 2007 <dd class="todo" style="display: none; "> 2008 Undocumented. 2009 </dd> 2010 <dd>Note: You cannot change an item to be a child of one of its own descendants.</dd> 2011 <dd style="display: none; "> 2012 This parameter was added in version 2013 <b><span></span></b>. 2014 You must omit this parameter in earlier versions, 2015 and you may omit it in any version. If you require this 2016 parameter, the manifest key 2017 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2018 can ensure that your extension won't be run in an earlier browser version. 2019 </dd> 2020 2021 <!-- OBJECT PROPERTIES --> 2022 <dd style="display: none; "> 2023 <dl> 2024 <div> 2025 <div> 2026 </div> 2027 </div> 2028 </dl> 2029 </dd> 2030 2031 <!-- FUNCTION PARAMETERS --> 2032 <dd style="display: none; "> 2033 <div></div> 2034 </dd> 2035 2036 </div> 2037 </div><div> 2038 <div> 2039 <dt> 2040 <var>documentUrlPatterns</var> 2041 <em> 2042 2043 <!-- TYPE --> 2044 <div style="display:inline"> 2045 ( 2046 <span class="optional">optional</span> 2047 <span class="enum" style="display: none; ">enumerated</span> 2048 <span id="typeTemplate"> 2049 <span style="display: none; "> 2050 <a> Type</a> 2051 </span> 2052 <span> 2053 <span> 2054 array of <span><span> 2055 <span style="display: none; "> 2056 <a> Type</a> 2057 </span> 2058 <span> 2059 <span style="display: none; "> 2060 array of <span><span></span></span> 2061 </span> 2062 <span>string</span> 2063 <span style="display: none; "></span> 2064 </span> 2065 </span></span> 2066 </span> 2067 <span style="display: none; ">paramType</span> 2068 <span style="display: none; "></span> 2069 </span> 2070 </span> 2071 ) 2072 </div> 2073 2074 </em> 2075 </dt> 2076 <dd class="todo"> 2077 Undocumented. 2078 </dd> 2079 <dd style="display: none; "> 2080 Description of this parameter from the json schema. 2081 </dd> 2082 <dd style="display: none; "> 2083 This parameter was added in version 2084 <b><span></span></b>. 2085 You must omit this parameter in earlier versions, 2086 and you may omit it in any version. If you require this 2087 parameter, the manifest key 2088 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2089 can ensure that your extension won't be run in an earlier browser version. 2090 </dd> 2091 2092 <!-- OBJECT PROPERTIES --> 2093 <dd style="display: none; "> 2094 <dl> 2095 <div> 2096 <div> 2097 </div> 2098 </div> 2099 </dl> 2100 </dd> 2101 2102 <!-- FUNCTION PARAMETERS --> 2103 <dd style="display: none; "> 2104 <div></div> 2105 </dd> 2106 2107 </div> 2108 </div><div> 2109 <div> 2110 <dt> 2111 <var>targetUrlPatterns</var> 2112 <em> 2113 2114 <!-- TYPE --> 2115 <div style="display:inline"> 2116 ( 2117 <span class="optional">optional</span> 2118 <span class="enum" style="display: none; ">enumerated</span> 2119 <span id="typeTemplate"> 2120 <span style="display: none; "> 2121 <a> Type</a> 2122 </span> 2123 <span> 2124 <span> 2125 array of <span><span> 2126 <span style="display: none; "> 2127 <a> Type</a> 2128 </span> 2129 <span> 2130 <span style="display: none; "> 2131 array of <span><span></span></span> 2132 </span> 2133 <span>string</span> 2134 <span style="display: none; "></span> 2135 </span> 2136 </span></span> 2137 </span> 2138 <span style="display: none; ">paramType</span> 2139 <span style="display: none; "></span> 2140 </span> 2141 </span> 2142 ) 2143 </div> 2144 2145 </em> 2146 </dt> 2147 <dd class="todo"> 2148 Undocumented. 2149 </dd> 2150 <dd style="display: none; "> 2151 Description of this parameter from the json schema. 2152 </dd> 2153 <dd style="display: none; "> 2154 This parameter was added in version 2155 <b><span></span></b>. 2156 You must omit this parameter in earlier versions, 2157 and you may omit it in any version. If you require this 2158 parameter, the manifest key 2159 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2160 can ensure that your extension won't be run in an earlier browser version. 2161 </dd> 2162 2163 <!-- OBJECT PROPERTIES --> 2164 <dd style="display: none; "> 2165 <dl> 2166 <div> 2167 <div> 2168 </div> 2169 </div> 2170 </dl> 2171 </dd> 2172 2173 <!-- FUNCTION PARAMETERS --> 2174 <dd style="display: none; "> 2175 <div></div> 2176 </dd> 2177 2178 </div> 2179 </div> 2180 </dl> 2181 </dd> 2182 2183 <!-- FUNCTION PARAMETERS --> 2184 <dd style="display: none; "> 2185 <div></div> 2186 </dd> 2187 2188 </div> 2189 </div><div> 2190 <div> 2191 <dt> 2192 <var>callback</var> 2193 <em> 2194 2195 <!-- TYPE --> 2196 <div style="display:inline"> 2197 ( 2198 <span class="optional">optional</span> 2199 <span class="enum" style="display: none; ">enumerated</span> 2200 <span id="typeTemplate"> 2201 <span style="display: none; "> 2202 <a> Type</a> 2203 </span> 2204 <span> 2205 <span style="display: none; "> 2206 array of <span><span></span></span> 2207 </span> 2208 <span>function</span> 2209 <span style="display: none; "></span> 2210 </span> 2211 </span> 2212 ) 2213 </div> 2214 2215 </em> 2216 </dt> 2217 <dd class="todo" style="display: none; "> 2218 Undocumented. 2219 </dd> 2220 <dd>Called when the context menu has been updated.</dd> 2221 <dd style="display: none; "> 2222 This parameter was added in version 2223 <b><span></span></b>. 2224 You must omit this parameter in earlier versions, 2225 and you may omit it in any version. If you require this 2226 parameter, the manifest key 2227 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2228 can ensure that your extension won't be run in an earlier browser version. 2229 </dd> 2230 2231 <!-- OBJECT PROPERTIES --> 2232 <dd style="display: none; "> 2233 <dl> 2234 <div> 2235 <div> 2236 </div> 2237 </div> 2238 </dl> 2239 </dd> 2240 2241 <!-- FUNCTION PARAMETERS --> 2242 <dd style="display: none; "> 2243 <div></div> 2244 </dd> 2245 2246 </div> 2247 </div> 2248 </dl> 2249 2250 <!-- RETURNS --> 2251 <h4 style="display: none; ">Returns</h4> 2252 <dl> 2253 <div style="display: none; "> 2254 <div> 2255 </div> 2256 </div> 2257 </dl> 2258 2259 <!-- CALLBACK --> 2260 <div> 2261 <div> 2262 <h4>Callback function</h4> 2263 <p style="display: none; "> 2264 The callback <em>parameter</em> should specify a function 2265 that looks like this: 2266 </p> 2267 <p> 2268 If you specify the <em>callback</em> parameter, it should 2269 specify a function that looks like this: 2270 </p> 2271 2272 <!-- Note: intentionally longer 80 columns --> 2273 <pre>function(<span></span>) <span class="subdued">{...}</span>;</pre> 2274 <dl> 2275 <div style="display: none; "> 2276 <div> 2277 </div> 2278 </div> 2279 </dl> 2280 </div> 2281 </div> 2282 2283 <!-- MIN_VERSION --> 2284 <p style="display: none; "> 2285 This function was added in version <b><span></span></b>. 2286 If you require this function, the manifest key 2287 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2288 can ensure that your extension won't be run in an earlier browser version. 2289 </p> 2290 </div> <!-- /description --> 2291 2292 </div> <!-- /apiItem --> 2293 2294 </div> <!-- /apiGroup --> 2295 2296 <!-- EVENTS --> 2297 <div class="apiGroup" style="display: none; "> 2298 <a name="events"></a> 2299 <h3 id="events">Events</h3> 2300 2301 <!-- iterates over all events --> 2302 <div class="apiItem"> 2303 <a></a> 2304 <h4>event name</h4> 2305 2306 <div class="summary"> 2307 <!-- Note: intentionally longer 80 columns --> 2308 <span class="subdued">chrome.bookmarks</span><span>onEvent</span><span class="subdued">.addListener</span>(function(<span>Type param1, Type param2</span>) <span class="subdued">{...}</span>); 2309 </div> 2310 2311 <div class="description"> 2312 <p class="todo">Undocumented.</p> 2313 <p> 2314 A description from the json schema def of the event goes here. 2315 </p> 2316 2317 <!-- PARAMETERS --> 2318 <h4>Parameters</h4> 2319 <dl> 2320 <div> 2321 <div> 2322 </div> 2323 </div> 2324 </dl> 2325 2326 </div> <!-- /decription --> 2327 2328 </div> <!-- /apiItem --> 2329 2330 </div> <!-- /apiGroup --> 2331 2332 <!-- TYPES --> 2333 <div class="apiGroup"> 2334 <a name="types"></a> 2335 <h3 id="types">Types</h3> 2336 2337 <!-- iterates over all types --> 2338 <div class="apiItem"> 2339 <a name="type-OnClickData"></a> 2340 <h4>OnClickData</h4> 2341 2342 <div> 2343 <dt> 2344 <var style="display: none; ">paramName</var> 2345 <em> 2346 2347 <!-- TYPE --> 2348 <div style="display:inline"> 2349 ( 2350 <span class="optional" style="display: none; ">optional</span> 2351 <span class="enum" style="display: none; ">enumerated</span> 2352 <span id="typeTemplate"> 2353 <span style="display: none; "> 2354 <a> Type</a> 2355 </span> 2356 <span> 2357 <span style="display: none; "> 2358 array of <span><span></span></span> 2359 </span> 2360 <span>object</span> 2361 <span style="display: none; "></span> 2362 </span> 2363 </span> 2364 ) 2365 </div> 2366 2367 </em> 2368 </dt> 2369 <dd class="todo" style="display: none; "> 2370 Undocumented. 2371 </dd> 2372 <dd>Information sent when a context menu item is clicked.</dd> 2373 <dd style="display: none; "> 2374 This parameter was added in version 2375 <b><span></span></b>. 2376 You must omit this parameter in earlier versions, 2377 and you may omit it in any version. If you require this 2378 parameter, the manifest key 2379 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2380 can ensure that your extension won't be run in an earlier browser version. 2381 </dd> 2382 2383 <!-- OBJECT PROPERTIES --> 2384 <dd> 2385 <dl> 2386 <div> 2387 <div> 2388 <dt> 2389 <var>menuItemId</var> 2390 <em> 2391 2392 <!-- TYPE --> 2393 <div style="display:inline"> 2394 ( 2395 <span class="optional" style="display: none; ">optional</span> 2396 <span class="enum" style="display: none; ">enumerated</span> 2397 <span id="typeTemplate"> 2398 <span style="display: none; "> 2399 <a> Type</a> 2400 </span> 2401 <span> 2402 <span style="display: none; "> 2403 array of <span><span></span></span> 2404 </span> 2405 <span>integer</span> 2406 <span style="display: none; "></span> 2407 </span> 2408 </span> 2409 ) 2410 </div> 2411 2412 </em> 2413 </dt> 2414 <dd class="todo" style="display: none; "> 2415 Undocumented. 2416 </dd> 2417 <dd>The ID of the menu item that was clicked.</dd> 2418 <dd style="display: none; "> 2419 This parameter was added in version 2420 <b><span></span></b>. 2421 You must omit this parameter in earlier versions, 2422 and you may omit it in any version. If you require this 2423 parameter, the manifest key 2424 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2425 can ensure that your extension won't be run in an earlier browser version. 2426 </dd> 2427 2428 <!-- OBJECT PROPERTIES --> 2429 <dd style="display: none; "> 2430 <dl> 2431 <div> 2432 <div> 2433 </div> 2434 </div> 2435 </dl> 2436 </dd> 2437 2438 <!-- FUNCTION PARAMETERS --> 2439 <dd style="display: none; "> 2440 <div></div> 2441 </dd> 2442 2443 </div> 2444 </div><div> 2445 <div> 2446 <dt> 2447 <var>parentMenuItemId</var> 2448 <em> 2449 2450 <!-- TYPE --> 2451 <div style="display:inline"> 2452 ( 2453 <span class="optional">optional</span> 2454 <span class="enum" style="display: none; ">enumerated</span> 2455 <span id="typeTemplate"> 2456 <span style="display: none; "> 2457 <a> Type</a> 2458 </span> 2459 <span> 2460 <span style="display: none; "> 2461 array of <span><span></span></span> 2462 </span> 2463 <span>integer</span> 2464 <span style="display: none; "></span> 2465 </span> 2466 </span> 2467 ) 2468 </div> 2469 2470 </em> 2471 </dt> 2472 <dd class="todo" style="display: none; "> 2473 Undocumented. 2474 </dd> 2475 <dd>The parent ID, if any, for the item clicked.</dd> 2476 <dd style="display: none; "> 2477 This parameter was added in version 2478 <b><span></span></b>. 2479 You must omit this parameter in earlier versions, 2480 and you may omit it in any version. If you require this 2481 parameter, the manifest key 2482 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2483 can ensure that your extension won't be run in an earlier browser version. 2484 </dd> 2485 2486 <!-- OBJECT PROPERTIES --> 2487 <dd style="display: none; "> 2488 <dl> 2489 <div> 2490 <div> 2491 </div> 2492 </div> 2493 </dl> 2494 </dd> 2495 2496 <!-- FUNCTION PARAMETERS --> 2497 <dd style="display: none; "> 2498 <div></div> 2499 </dd> 2500 2501 </div> 2502 </div><div> 2503 <div> 2504 <dt> 2505 <var>mediaType</var> 2506 <em> 2507 2508 <!-- TYPE --> 2509 <div style="display:inline"> 2510 ( 2511 <span class="optional">optional</span> 2512 <span class="enum" style="display: none; ">enumerated</span> 2513 <span id="typeTemplate"> 2514 <span style="display: none; "> 2515 <a> Type</a> 2516 </span> 2517 <span> 2518 <span style="display: none; "> 2519 array of <span><span></span></span> 2520 </span> 2521 <span>string</span> 2522 <span style="display: none; "></span> 2523 </span> 2524 </span> 2525 ) 2526 </div> 2527 2528 </em> 2529 </dt> 2530 <dd class="todo" style="display: none; "> 2531 Undocumented. 2532 </dd> 2533 <dd>One of 'image', 'video', or 'audio' if the context menu was activated on one of these types of elements.</dd> 2534 <dd style="display: none; "> 2535 This parameter was added in version 2536 <b><span></span></b>. 2537 You must omit this parameter in earlier versions, 2538 and you may omit it in any version. If you require this 2539 parameter, the manifest key 2540 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2541 can ensure that your extension won't be run in an earlier browser version. 2542 </dd> 2543 2544 <!-- OBJECT PROPERTIES --> 2545 <dd style="display: none; "> 2546 <dl> 2547 <div> 2548 <div> 2549 </div> 2550 </div> 2551 </dl> 2552 </dd> 2553 2554 <!-- FUNCTION PARAMETERS --> 2555 <dd style="display: none; "> 2556 <div></div> 2557 </dd> 2558 2559 </div> 2560 </div><div> 2561 <div> 2562 <dt> 2563 <var>linkUrl</var> 2564 <em> 2565 2566 <!-- TYPE --> 2567 <div style="display:inline"> 2568 ( 2569 <span class="optional">optional</span> 2570 <span class="enum" style="display: none; ">enumerated</span> 2571 <span id="typeTemplate"> 2572 <span style="display: none; "> 2573 <a> Type</a> 2574 </span> 2575 <span> 2576 <span style="display: none; "> 2577 array of <span><span></span></span> 2578 </span> 2579 <span>string</span> 2580 <span style="display: none; "></span> 2581 </span> 2582 </span> 2583 ) 2584 </div> 2585 2586 </em> 2587 </dt> 2588 <dd class="todo" style="display: none; "> 2589 Undocumented. 2590 </dd> 2591 <dd>If the element is a link, the URL it points to.</dd> 2592 <dd style="display: none; "> 2593 This parameter was added in version 2594 <b><span></span></b>. 2595 You must omit this parameter in earlier versions, 2596 and you may omit it in any version. If you require this 2597 parameter, the manifest key 2598 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2599 can ensure that your extension won't be run in an earlier browser version. 2600 </dd> 2601 2602 <!-- OBJECT PROPERTIES --> 2603 <dd style="display: none; "> 2604 <dl> 2605 <div> 2606 <div> 2607 </div> 2608 </div> 2609 </dl> 2610 </dd> 2611 2612 <!-- FUNCTION PARAMETERS --> 2613 <dd style="display: none; "> 2614 <div></div> 2615 </dd> 2616 2617 </div> 2618 </div><div> 2619 <div> 2620 <dt> 2621 <var>srcUrl</var> 2622 <em> 2623 2624 <!-- TYPE --> 2625 <div style="display:inline"> 2626 ( 2627 <span class="optional">optional</span> 2628 <span class="enum" style="display: none; ">enumerated</span> 2629 <span id="typeTemplate"> 2630 <span style="display: none; "> 2631 <a> Type</a> 2632 </span> 2633 <span> 2634 <span style="display: none; "> 2635 array of <span><span></span></span> 2636 </span> 2637 <span>string</span> 2638 <span style="display: none; "></span> 2639 </span> 2640 </span> 2641 ) 2642 </div> 2643 2644 </em> 2645 </dt> 2646 <dd class="todo" style="display: none; "> 2647 Undocumented. 2648 </dd> 2649 <dd>Will be present for elements with a 'src' URL.</dd> 2650 <dd style="display: none; "> 2651 This parameter was added in version 2652 <b><span></span></b>. 2653 You must omit this parameter in earlier versions, 2654 and you may omit it in any version. If you require this 2655 parameter, the manifest key 2656 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2657 can ensure that your extension won't be run in an earlier browser version. 2658 </dd> 2659 2660 <!-- OBJECT PROPERTIES --> 2661 <dd style="display: none; "> 2662 <dl> 2663 <div> 2664 <div> 2665 </div> 2666 </div> 2667 </dl> 2668 </dd> 2669 2670 <!-- FUNCTION PARAMETERS --> 2671 <dd style="display: none; "> 2672 <div></div> 2673 </dd> 2674 2675 </div> 2676 </div><div> 2677 <div> 2678 <dt> 2679 <var>pageUrl</var> 2680 <em> 2681 2682 <!-- TYPE --> 2683 <div style="display:inline"> 2684 ( 2685 <span class="optional" style="display: none; ">optional</span> 2686 <span class="enum" style="display: none; ">enumerated</span> 2687 <span id="typeTemplate"> 2688 <span style="display: none; "> 2689 <a> Type</a> 2690 </span> 2691 <span> 2692 <span style="display: none; "> 2693 array of <span><span></span></span> 2694 </span> 2695 <span>string</span> 2696 <span style="display: none; "></span> 2697 </span> 2698 </span> 2699 ) 2700 </div> 2701 2702 </em> 2703 </dt> 2704 <dd class="todo" style="display: none; "> 2705 Undocumented. 2706 </dd> 2707 <dd>The URL of the page where the menu item was clicked.</dd> 2708 <dd style="display: none; "> 2709 This parameter was added in version 2710 <b><span></span></b>. 2711 You must omit this parameter in earlier versions, 2712 and you may omit it in any version. If you require this 2713 parameter, the manifest key 2714 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2715 can ensure that your extension won't be run in an earlier browser version. 2716 </dd> 2717 2718 <!-- OBJECT PROPERTIES --> 2719 <dd style="display: none; "> 2720 <dl> 2721 <div> 2722 <div> 2723 </div> 2724 </div> 2725 </dl> 2726 </dd> 2727 2728 <!-- FUNCTION PARAMETERS --> 2729 <dd style="display: none; "> 2730 <div></div> 2731 </dd> 2732 2733 </div> 2734 </div><div> 2735 <div> 2736 <dt> 2737 <var>frameUrl</var> 2738 <em> 2739 2740 <!-- TYPE --> 2741 <div style="display:inline"> 2742 ( 2743 <span class="optional">optional</span> 2744 <span class="enum" style="display: none; ">enumerated</span> 2745 <span id="typeTemplate"> 2746 <span style="display: none; "> 2747 <a> Type</a> 2748 </span> 2749 <span> 2750 <span style="display: none; "> 2751 array of <span><span></span></span> 2752 </span> 2753 <span>string</span> 2754 <span style="display: none; "></span> 2755 </span> 2756 </span> 2757 ) 2758 </div> 2759 2760 </em> 2761 </dt> 2762 <dd class="todo" style="display: none; "> 2763 Undocumented. 2764 </dd> 2765 <dd> The URL of the frame of the element where the context menu was clicked, if it was in a frame.</dd> 2766 <dd style="display: none; "> 2767 This parameter was added in version 2768 <b><span></span></b>. 2769 You must omit this parameter in earlier versions, 2770 and you may omit it in any version. If you require this 2771 parameter, the manifest key 2772 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2773 can ensure that your extension won't be run in an earlier browser version. 2774 </dd> 2775 2776 <!-- OBJECT PROPERTIES --> 2777 <dd style="display: none; "> 2778 <dl> 2779 <div> 2780 <div> 2781 </div> 2782 </div> 2783 </dl> 2784 </dd> 2785 2786 <!-- FUNCTION PARAMETERS --> 2787 <dd style="display: none; "> 2788 <div></div> 2789 </dd> 2790 2791 </div> 2792 </div><div> 2793 <div> 2794 <dt> 2795 <var>selectionText</var> 2796 <em> 2797 2798 <!-- TYPE --> 2799 <div style="display:inline"> 2800 ( 2801 <span class="optional">optional</span> 2802 <span class="enum" style="display: none; ">enumerated</span> 2803 <span id="typeTemplate"> 2804 <span style="display: none; "> 2805 <a> Type</a> 2806 </span> 2807 <span> 2808 <span style="display: none; "> 2809 array of <span><span></span></span> 2810 </span> 2811 <span>string</span> 2812 <span style="display: none; "></span> 2813 </span> 2814 </span> 2815 ) 2816 </div> 2817 2818 </em> 2819 </dt> 2820 <dd class="todo" style="display: none; "> 2821 Undocumented. 2822 </dd> 2823 <dd>The text for the context selection, if any.</dd> 2824 <dd style="display: none; "> 2825 This parameter was added in version 2826 <b><span></span></b>. 2827 You must omit this parameter in earlier versions, 2828 and you may omit it in any version. If you require this 2829 parameter, the manifest key 2830 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2831 can ensure that your extension won't be run in an earlier browser version. 2832 </dd> 2833 2834 <!-- OBJECT PROPERTIES --> 2835 <dd style="display: none; "> 2836 <dl> 2837 <div> 2838 <div> 2839 </div> 2840 </div> 2841 </dl> 2842 </dd> 2843 2844 <!-- FUNCTION PARAMETERS --> 2845 <dd style="display: none; "> 2846 <div></div> 2847 </dd> 2848 2849 </div> 2850 </div><div> 2851 <div> 2852 <dt> 2853 <var>editable</var> 2854 <em> 2855 2856 <!-- TYPE --> 2857 <div style="display:inline"> 2858 ( 2859 <span class="optional" style="display: none; ">optional</span> 2860 <span class="enum" style="display: none; ">enumerated</span> 2861 <span id="typeTemplate"> 2862 <span style="display: none; "> 2863 <a> Type</a> 2864 </span> 2865 <span> 2866 <span style="display: none; "> 2867 array of <span><span></span></span> 2868 </span> 2869 <span>string</span> 2870 <span style="display: none; "></span> 2871 </span> 2872 </span> 2873 ) 2874 </div> 2875 2876 </em> 2877 </dt> 2878 <dd class="todo" style="display: none; "> 2879 Undocumented. 2880 </dd> 2881 <dd>A flag indicating whether the element is editable (text input, textarea, etc.).</dd> 2882 <dd style="display: none; "> 2883 This parameter was added in version 2884 <b><span></span></b>. 2885 You must omit this parameter in earlier versions, 2886 and you may omit it in any version. If you require this 2887 parameter, the manifest key 2888 <a href="manifest.html#minimum_chrome_version">minimum_chrome_version</a> 2889 can ensure that your extension won't be run in an earlier browser version. 2890 </dd> 2891 2892 <!-- OBJECT PROPERTIES --> 2893 <dd style="display: none; "> 2894 <dl> 2895 <div> 2896 <div> 2897 </div> 2898 </div> 2899 </dl> 2900 </dd> 2901 2902 <!-- FUNCTION PARAMETERS --> 2903 <dd style="display: none; "> 2904 <div></div> 2905 </dd> 2906 2907 </div> 2908 </div> 2909 </dl> 2910 </dd> 2911 2912 <!-- FUNCTION PARAMETERS --> 2913 <dd style="display: none; "> 2914 <div></div> 2915 </dd> 2916 2917 </div> 2918 2919 </div> <!-- /apiItem --> 2920 2921 </div> <!-- /apiGroup --> 2922 2923 </div> <!-- /apiPage --> 2924 </div> <!-- /gc-pagecontent --> 2925 </div> <!-- /g-section --> 2926 </div> <!-- /codesiteContent --> 2927 <div id="gc-footer" --=""> 2928 <div class="text"> 2929 <p> 2930 Except as otherwise <a href="http://code.google.com/policies.html#restrictions">noted</a>, 2931 the content of this page is licensed under the <a rel="license" href="http://creativecommons.org/licenses/by/3.0/">Creative Commons 2932 Attribution 3.0 License</a>, and code samples are licensed under the 2933 <a rel="license" href="http://code.google.com/google_bsd_license.html">BSD License</a>. 2934 </p> 2935 <p> 2936 ©2011 Google 2937 </p> 2938 2939<!-- begin analytics --> 2940<script src="http://www.google-analytics.com/urchin.js" type="text/javascript"></script> 2941<script src="http://www.google-analytics.com/ga.js" type="text/javascript"></script> 2942 2943<script type="text/javascript"> 2944 // chrome doc tracking 2945 try { 2946 var engdocs = _gat._getTracker("YT-10763712-2"); 2947 engdocs._trackPageview(); 2948 } catch(err) {} 2949 2950 // code.google.com site-wide tracking 2951 try { 2952 _uacct="UA-18071-1"; 2953 _uanchor=1; 2954 _uff=0; 2955 urchinTracker(); 2956 } 2957 catch(e) {/* urchinTracker not available. */} 2958</script> 2959<!-- end analytics --> 2960 </div> 2961 </div> <!-- /gc-footer --> 2962 </div> <!-- /gc-container --> 2963</body></html> 2964
