**Inheritance:** java.lang.Object ``` public class WebExtension ``` Represents a web extension object. To learn more, visit the [ Work with Office Add-ins ][Work with Office Add-ins] documentation article. **Examples:** Shows how to add a web extension to a document. ``` Document doc = new Document(); // Create task pane with "MyScript" add-in, which will be used by the document, // then set its default location. TaskPane myScriptTaskPane = new TaskPane(); doc.getWebExtensionTaskPanes().add(myScriptTaskPane); myScriptTaskPane.setDockState(TaskPaneDockState.RIGHT); myScriptTaskPane.isVisible(true); myScriptTaskPane.setWidth(300.0); myScriptTaskPane.isLocked(true); // If there are multiple task panes in the same docking location, we can set this index to arrange them. myScriptTaskPane.setRow(1); // Create an add-in called "MyScript Math Sample", which the task pane will display within. WebExtension webExtension = myScriptTaskPane.getWebExtension(); // Set application store reference parameters for our add-in, such as the ID. webExtension.getReference().setId("WA104380646"); webExtension.getReference().setVersion("1.0.0.0"); webExtension.getReference().setStoreType(WebExtensionStoreType.OMEX); webExtension.getReference().setStore("English (United States)"); webExtension.getProperties().add(new WebExtensionProperty("MyScript", "MyScript Math Sample")); webExtension.getBindings().add(new WebExtensionBinding("MyScript", WebExtensionBindingType.TEXT, "104380646")); // Allow the user to interact with the add-in. webExtension.isFrozen(false); // We can access the web extension in Microsoft Word via Developer -> Add-ins. doc.save(getArtifactsDir() + "Document.WebExtension.docx"); // Remove all web extension task panes at once like this. doc.getWebExtensionTaskPanes().clear(); Assert.assertEquals(0, doc.getWebExtensionTaskPanes().getCount()); doc = new Document(getArtifactsDir() + "Document.WebExtension.docx"); myScriptTaskPane = doc.getWebExtensionTaskPanes().get(0); Assert.assertEquals(TaskPaneDockState.RIGHT, myScriptTaskPane.getDockState()); Assert.assertTrue(myScriptTaskPane.isVisible()); Assert.assertEquals(300.0d, myScriptTaskPane.getWidth()); Assert.assertTrue(myScriptTaskPane.isLocked()); Assert.assertEquals(1, myScriptTaskPane.getRow()); webExtension = myScriptTaskPane.getWebExtension(); Assert.assertEquals("", webExtension.getId()); Assert.assertEquals("WA104380646", webExtension.getReference().getId()); Assert.assertEquals("1.0.0.0", webExtension.getReference().getVersion()); Assert.assertEquals(WebExtensionStoreType.OMEX, webExtension.getReference().getStoreType()); Assert.assertEquals("English (United States)", webExtension.getReference().getStore()); Assert.assertEquals(0, webExtension.getAlternateReferences().getCount()); Assert.assertEquals("MyScript", webExtension.getProperties().get(0).getName()); Assert.assertEquals("MyScript Math Sample", webExtension.getProperties().get(0).getValue()); Assert.assertEquals("MyScript", webExtension.getBindings().get(0).getId()); Assert.assertEquals(WebExtensionBindingType.TEXT, webExtension.getBindings().get(0).getBindingType()); Assert.assertEquals("104380646", webExtension.getBindings().get(0).getAppRef()); Assert.assertFalse(webExtension.isFrozen()); ``` [Work with Office Add-ins]: https://docs.aspose.com/words/java/work-with-office-add-ins/ ## Methods | Method | Description | | --- | --- | | [getAlternateReferences()](#getAlternateReferences) | Specifies alternate references to a web extension. | | [getBindings()](#getBindings) | Specifies a list of web extension bindings. | | [getId()](#getId) | Uniquely identifies the web extension instance in the current document. | | [getProperties()](#getProperties) | Represents a set of web extension custom properties. | | [getReference()](#getReference) | Specifies the primary reference to an web extension. | | [isFrozen()](#isFrozen) | Specifies whether the user can interact with the web extension or not. | | [isFrozen(boolean value)](#isFrozen-boolean) | Specifies whether the user can interact with the web extension or not. | | [setId(String value)](#setId-java.lang.String) | Uniquely identifies the web extension instance in the current document. | ### getAlternateReferences() {#getAlternateReferences} ``` public WebExtensionReferenceCollection getAlternateReferences() ``` Specifies alternate references to a web extension. **Examples:** Shows how to add a web extension to a document. ``` Document doc = new Document(); // Create task pane with "MyScript" add-in, which will be used by the document, // then set its default location. TaskPane myScriptTaskPane = new TaskPane(); doc.getWebExtensionTaskPanes().add(myScriptTaskPane); myScriptTaskPane.setDockState(TaskPaneDockState.RIGHT); myScriptTaskPane.isVisible(true); myScriptTaskPane.setWidth(300.0); myScriptTaskPane.isLocked(true); // If there are multiple task panes in the same docking location, we can set this index to arrange them. myScriptTaskPane.setRow(1); // Create an add-in called "MyScript Math Sample", which the task pane will display within. WebExtension webExtension = myScriptTaskPane.getWebExtension(); // Set application store reference parameters for our add-in, such as the ID. webExtension.getReference().setId("WA104380646"); webExtension.getReference().setVersion("1.0.0.0"); webExtension.getReference().setStoreType(WebExtensionStoreType.OMEX); webExtension.getReference().setStore("English (United States)"); webExtension.getProperties().add(new WebExtensionProperty("MyScript", "MyScript Math Sample")); webExtension.getBindings().add(new WebExtensionBinding("MyScript", WebExtensionBindingType.TEXT, "104380646")); // Allow the user to interact with the add-in. webExtension.isFrozen(false); // We can access the web extension in Microsoft Word via Developer -> Add-ins. doc.save(getArtifactsDir() + "Document.WebExtension.docx"); // Remove all web extension task panes at once like this. doc.getWebExtensionTaskPanes().clear(); Assert.assertEquals(0, doc.getWebExtensionTaskPanes().getCount()); doc = new Document(getArtifactsDir() + "Document.WebExtension.docx"); myScriptTaskPane = doc.getWebExtensionTaskPanes().get(0); Assert.assertEquals(TaskPaneDockState.RIGHT, myScriptTaskPane.getDockState()); Assert.assertTrue(myScriptTaskPane.isVisible()); Assert.assertEquals(300.0d, myScriptTaskPane.getWidth()); Assert.assertTrue(myScriptTaskPane.isLocked()); Assert.assertEquals(1, myScriptTaskPane.getRow()); webExtension = myScriptTaskPane.getWebExtension(); Assert.assertEquals("", webExtension.getId()); Assert.assertEquals("WA104380646", webExtension.getReference().getId()); Assert.assertEquals("1.0.0.0", webExtension.getReference().getVersion()); Assert.assertEquals(WebExtensionStoreType.OMEX, webExtension.getReference().getStoreType()); Assert.assertEquals("English (United States)", webExtension.getReference().getStore()); Assert.assertEquals(0, webExtension.getAlternateReferences().getCount()); Assert.assertEquals("MyScript", webExtension.getProperties().get(0).getName()); Assert.assertEquals("MyScript Math Sample", webExtension.getProperties().get(0).getValue()); Assert.assertEquals("MyScript", webExtension.getBindings().get(0).getId()); Assert.assertEquals(WebExtensionBindingType.TEXT, webExtension.getBindings().get(0).getBindingType()); Assert.assertEquals("104380646", webExtension.getBindings().get(0).getAppRef()); Assert.assertFalse(webExtension.isFrozen()); ``` **Returns:** [WebExtensionReferenceCollection](../../com.aspose.words/webextensionreferencecollection/) - The corresponding [WebExtensionReferenceCollection](../../com.aspose.words/webextensionreferencecollection/) value. ### getBindings() {#getBindings} ``` public WebExtensionBindingCollection getBindings() ``` Specifies a list of web extension bindings. **Examples:** Shows how to add a web extension to a document. ``` Document doc = new Document(); // Create task pane with "MyScript" add-in, which will be used by the document, // then set its default location. TaskPane myScriptTaskPane = new TaskPane(); doc.getWebExtensionTaskPanes().add(myScriptTaskPane); myScriptTaskPane.setDockState(TaskPaneDockState.RIGHT); myScriptTaskPane.isVisible(true); myScriptTaskPane.setWidth(300.0); myScriptTaskPane.isLocked(true); // If there are multiple task panes in the same docking location, we can set this index to arrange them. myScriptTaskPane.setRow(1); // Create an add-in called "MyScript Math Sample", which the task pane will display within. WebExtension webExtension = myScriptTaskPane.getWebExtension(); // Set application store reference parameters for our add-in, such as the ID. webExtension.getReference().setId("WA104380646"); webExtension.getReference().setVersion("1.0.0.0"); webExtension.getReference().setStoreType(WebExtensionStoreType.OMEX); webExtension.getReference().setStore("English (United States)"); webExtension.getProperties().add(new WebExtensionProperty("MyScript", "MyScript Math Sample")); webExtension.getBindings().add(new WebExtensionBinding("MyScript", WebExtensionBindingType.TEXT, "104380646")); // Allow the user to interact with the add-in. webExtension.isFrozen(false); // We can access the web extension in Microsoft Word via Developer -> Add-ins. doc.save(getArtifactsDir() + "Document.WebExtension.docx"); // Remove all web extension task panes at once like this. doc.getWebExtensionTaskPanes().clear(); Assert.assertEquals(0, doc.getWebExtensionTaskPanes().getCount()); doc = new Document(getArtifactsDir() + "Document.WebExtension.docx"); myScriptTaskPane = doc.getWebExtensionTaskPanes().get(0); Assert.assertEquals(TaskPaneDockState.RIGHT, myScriptTaskPane.getDockState()); Assert.assertTrue(myScriptTaskPane.isVisible()); Assert.assertEquals(300.0d, myScriptTaskPane.getWidth()); Assert.assertTrue(myScriptTaskPane.isLocked()); Assert.assertEquals(1, myScriptTaskPane.getRow()); webExtension = myScriptTaskPane.getWebExtension(); Assert.assertEquals("", webExtension.getId()); Assert.assertEquals("WA104380646", webExtension.getReference().getId()); Assert.assertEquals("1.0.0.0", webExtension.getReference().getVersion()); Assert.assertEquals(WebExtensionStoreType.OMEX, webExtension.getReference().getStoreType()); Assert.assertEquals("English (United States)", webExtension.getReference().getStore()); Assert.assertEquals(0, webExtension.getAlternateReferences().getCount()); Assert.assertEquals("MyScript", webExtension.getProperties().get(0).getName()); Assert.assertEquals("MyScript Math Sample", webExtension.getProperties().get(0).getValue()); Assert.assertEquals("MyScript", webExtension.getBindings().get(0).getId()); Assert.assertEquals(WebExtensionBindingType.TEXT, webExtension.getBindings().get(0).getBindingType()); Assert.assertEquals("104380646", webExtension.getBindings().get(0).getAppRef()); Assert.assertFalse(webExtension.isFrozen()); ``` **Returns:** [WebExtensionBindingCollection](../../com.aspose.words/webextensionbindingcollection/) - The corresponding [WebExtensionBindingCollection](../../com.aspose.words/webextensionbindingcollection/) value. ### getId() {#getId} ``` public String getId() ``` Uniquely identifies the web extension instance in the current document. **Examples:** Shows how to add a web extension to a document. ``` Document doc = new Document(); // Create task pane with "MyScript" add-in, which will be used by the document, // then set its default location. TaskPane myScriptTaskPane = new TaskPane(); doc.getWebExtensionTaskPanes().add(myScriptTaskPane); myScriptTaskPane.setDockState(TaskPaneDockState.RIGHT); myScriptTaskPane.isVisible(true); myScriptTaskPane.setWidth(300.0); myScriptTaskPane.isLocked(true); // If there are multiple task panes in the same docking location, we can set this index to arrange them. myScriptTaskPane.setRow(1); // Create an add-in called "MyScript Math Sample", which the task pane will display within. WebExtension webExtension = myScriptTaskPane.getWebExtension(); // Set application store reference parameters for our add-in, such as the ID. webExtension.getReference().setId("WA104380646"); webExtension.getReference().setVersion("1.0.0.0"); webExtension.getReference().setStoreType(WebExtensionStoreType.OMEX); webExtension.getReference().setStore("English (United States)"); webExtension.getProperties().add(new WebExtensionProperty("MyScript", "MyScript Math Sample")); webExtension.getBindings().add(new WebExtensionBinding("MyScript", WebExtensionBindingType.TEXT, "104380646")); // Allow the user to interact with the add-in. webExtension.isFrozen(false); // We can access the web extension in Microsoft Word via Developer -> Add-ins. doc.save(getArtifactsDir() + "Document.WebExtension.docx"); // Remove all web extension task panes at once like this. doc.getWebExtensionTaskPanes().clear(); Assert.assertEquals(0, doc.getWebExtensionTaskPanes().getCount()); doc = new Document(getArtifactsDir() + "Document.WebExtension.docx"); myScriptTaskPane = doc.getWebExtensionTaskPanes().get(0); Assert.assertEquals(TaskPaneDockState.RIGHT, myScriptTaskPane.getDockState()); Assert.assertTrue(myScriptTaskPane.isVisible()); Assert.assertEquals(300.0d, myScriptTaskPane.getWidth()); Assert.assertTrue(myScriptTaskPane.isLocked()); Assert.assertEquals(1, myScriptTaskPane.getRow()); webExtension = myScriptTaskPane.getWebExtension(); Assert.assertEquals("", webExtension.getId()); Assert.assertEquals("WA104380646", webExtension.getReference().getId()); Assert.assertEquals("1.0.0.0", webExtension.getReference().getVersion()); Assert.assertEquals(WebExtensionStoreType.OMEX, webExtension.getReference().getStoreType()); Assert.assertEquals("English (United States)", webExtension.getReference().getStore()); Assert.assertEquals(0, webExtension.getAlternateReferences().getCount()); Assert.assertEquals("MyScript", webExtension.getProperties().get(0).getName()); Assert.assertEquals("MyScript Math Sample", webExtension.getProperties().get(0).getValue()); Assert.assertEquals("MyScript", webExtension.getBindings().get(0).getId()); Assert.assertEquals(WebExtensionBindingType.TEXT, webExtension.getBindings().get(0).getBindingType()); Assert.assertEquals("104380646", webExtension.getBindings().get(0).getAppRef()); Assert.assertFalse(webExtension.isFrozen()); ``` **Returns:** java.lang.String - The corresponding java.lang.String value. ### getProperties() {#getProperties} ``` public WebExtensionPropertyCollection getProperties() ``` Represents a set of web extension custom properties. **Examples:** Shows how to add a web extension to a document. ``` Document doc = new Document(); // Create task pane with "MyScript" add-in, which will be used by the document, // then set its default location. TaskPane myScriptTaskPane = new TaskPane(); doc.getWebExtensionTaskPanes().add(myScriptTaskPane); myScriptTaskPane.setDockState(TaskPaneDockState.RIGHT); myScriptTaskPane.isVisible(true); myScriptTaskPane.setWidth(300.0); myScriptTaskPane.isLocked(true); // If there are multiple task panes in the same docking location, we can set this index to arrange them. myScriptTaskPane.setRow(1); // Create an add-in called "MyScript Math Sample", which the task pane will display within. WebExtension webExtension = myScriptTaskPane.getWebExtension(); // Set application store reference parameters for our add-in, such as the ID. webExtension.getReference().setId("WA104380646"); webExtension.getReference().setVersion("1.0.0.0"); webExtension.getReference().setStoreType(WebExtensionStoreType.OMEX); webExtension.getReference().setStore("English (United States)"); webExtension.getProperties().add(new WebExtensionProperty("MyScript", "MyScript Math Sample")); webExtension.getBindings().add(new WebExtensionBinding("MyScript", WebExtensionBindingType.TEXT, "104380646")); // Allow the user to interact with the add-in. webExtension.isFrozen(false); // We can access the web extension in Microsoft Word via Developer -> Add-ins. doc.save(getArtifactsDir() + "Document.WebExtension.docx"); // Remove all web extension task panes at once like this. doc.getWebExtensionTaskPanes().clear(); Assert.assertEquals(0, doc.getWebExtensionTaskPanes().getCount()); doc = new Document(getArtifactsDir() + "Document.WebExtension.docx"); myScriptTaskPane = doc.getWebExtensionTaskPanes().get(0); Assert.assertEquals(TaskPaneDockState.RIGHT, myScriptTaskPane.getDockState()); Assert.assertTrue(myScriptTaskPane.isVisible()); Assert.assertEquals(300.0d, myScriptTaskPane.getWidth()); Assert.assertTrue(myScriptTaskPane.isLocked()); Assert.assertEquals(1, myScriptTaskPane.getRow()); webExtension = myScriptTaskPane.getWebExtension(); Assert.assertEquals("", webExtension.getId()); Assert.assertEquals("WA104380646", webExtension.getReference().getId()); Assert.assertEquals("1.0.0.0", webExtension.getReference().getVersion()); Assert.assertEquals(WebExtensionStoreType.OMEX, webExtension.getReference().getStoreType()); Assert.assertEquals("English (United States)", webExtension.getReference().getStore()); Assert.assertEquals(0, webExtension.getAlternateReferences().getCount()); Assert.assertEquals("MyScript", webExtension.getProperties().get(0).getName()); Assert.assertEquals("MyScript Math Sample", webExtension.getProperties().get(0).getValue()); Assert.assertEquals("MyScript", webExtension.getBindings().get(0).getId()); Assert.assertEquals(WebExtensionBindingType.TEXT, webExtension.getBindings().get(0).getBindingType()); Assert.assertEquals("104380646", webExtension.getBindings().get(0).getAppRef()); Assert.assertFalse(webExtension.isFrozen()); ``` **Returns:** [WebExtensionPropertyCollection](../../com.aspose.words/webextensionpropertycollection/) - The corresponding [WebExtensionPropertyCollection](../../com.aspose.words/webextensionpropertycollection/) value. ### getReference() {#getReference} ``` public WebExtensionReference getReference() ``` Specifies the primary reference to an web extension. **Examples:** Shows how to add a web extension to a document. ``` Document doc = new Document(); // Create task pane with "MyScript" add-in, which will be used by the document, // then set its default location. TaskPane myScriptTaskPane = new TaskPane(); doc.getWebExtensionTaskPanes().add(myScriptTaskPane); myScriptTaskPane.setDockState(TaskPaneDockState.RIGHT); myScriptTaskPane.isVisible(true); myScriptTaskPane.setWidth(300.0); myScriptTaskPane.isLocked(true); // If there are multiple task panes in the same docking location, we can set this index to arrange them. myScriptTaskPane.setRow(1); // Create an add-in called "MyScript Math Sample", which the task pane will display within. WebExtension webExtension = myScriptTaskPane.getWebExtension(); // Set application store reference parameters for our add-in, such as the ID. webExtension.getReference().setId("WA104380646"); webExtension.getReference().setVersion("1.0.0.0"); webExtension.getReference().setStoreType(WebExtensionStoreType.OMEX); webExtension.getReference().setStore("English (United States)"); webExtension.getProperties().add(new WebExtensionProperty("MyScript", "MyScript Math Sample")); webExtension.getBindings().add(new WebExtensionBinding("MyScript", WebExtensionBindingType.TEXT, "104380646")); // Allow the user to interact with the add-in. webExtension.isFrozen(false); // We can access the web extension in Microsoft Word via Developer -> Add-ins. doc.save(getArtifactsDir() + "Document.WebExtension.docx"); // Remove all web extension task panes at once like this. doc.getWebExtensionTaskPanes().clear(); Assert.assertEquals(0, doc.getWebExtensionTaskPanes().getCount()); doc = new Document(getArtifactsDir() + "Document.WebExtension.docx"); myScriptTaskPane = doc.getWebExtensionTaskPanes().get(0); Assert.assertEquals(TaskPaneDockState.RIGHT, myScriptTaskPane.getDockState()); Assert.assertTrue(myScriptTaskPane.isVisible()); Assert.assertEquals(300.0d, myScriptTaskPane.getWidth()); Assert.assertTrue(myScriptTaskPane.isLocked()); Assert.assertEquals(1, myScriptTaskPane.getRow()); webExtension = myScriptTaskPane.getWebExtension(); Assert.assertEquals("", webExtension.getId()); Assert.assertEquals("WA104380646", webExtension.getReference().getId()); Assert.assertEquals("1.0.0.0", webExtension.getReference().getVersion()); Assert.assertEquals(WebExtensionStoreType.OMEX, webExtension.getReference().getStoreType()); Assert.assertEquals("English (United States)", webExtension.getReference().getStore()); Assert.assertEquals(0, webExtension.getAlternateReferences().getCount()); Assert.assertEquals("MyScript", webExtension.getProperties().get(0).getName()); Assert.assertEquals("MyScript Math Sample", webExtension.getProperties().get(0).getValue()); Assert.assertEquals("MyScript", webExtension.getBindings().get(0).getId()); Assert.assertEquals(WebExtensionBindingType.TEXT, webExtension.getBindings().get(0).getBindingType()); Assert.assertEquals("104380646", webExtension.getBindings().get(0).getAppRef()); Assert.assertFalse(webExtension.isFrozen()); ``` **Returns:** [WebExtensionReference](../../com.aspose.words/webextensionreference/) - The corresponding [WebExtensionReference](../../com.aspose.words/webextensionreference/) value. ### isFrozen() {#isFrozen} ``` public boolean isFrozen() ``` Specifies whether the user can interact with the web extension or not. **Examples:** Shows how to add a web extension to a document. ``` Document doc = new Document(); // Create task pane with "MyScript" add-in, which will be used by the document, // then set its default location. TaskPane myScriptTaskPane = new TaskPane(); doc.getWebExtensionTaskPanes().add(myScriptTaskPane); myScriptTaskPane.setDockState(TaskPaneDockState.RIGHT); myScriptTaskPane.isVisible(true); myScriptTaskPane.setWidth(300.0); myScriptTaskPane.isLocked(true); // If there are multiple task panes in the same docking location, we can set this index to arrange them. myScriptTaskPane.setRow(1); // Create an add-in called "MyScript Math Sample", which the task pane will display within. WebExtension webExtension = myScriptTaskPane.getWebExtension(); // Set application store reference parameters for our add-in, such as the ID. webExtension.getReference().setId("WA104380646"); webExtension.getReference().setVersion("1.0.0.0"); webExtension.getReference().setStoreType(WebExtensionStoreType.OMEX); webExtension.getReference().setStore("English (United States)"); webExtension.getProperties().add(new WebExtensionProperty("MyScript", "MyScript Math Sample")); webExtension.getBindings().add(new WebExtensionBinding("MyScript", WebExtensionBindingType.TEXT, "104380646")); // Allow the user to interact with the add-in. webExtension.isFrozen(false); // We can access the web extension in Microsoft Word via Developer -> Add-ins. doc.save(getArtifactsDir() + "Document.WebExtension.docx"); // Remove all web extension task panes at once like this. doc.getWebExtensionTaskPanes().clear(); Assert.assertEquals(0, doc.getWebExtensionTaskPanes().getCount()); doc = new Document(getArtifactsDir() + "Document.WebExtension.docx"); myScriptTaskPane = doc.getWebExtensionTaskPanes().get(0); Assert.assertEquals(TaskPaneDockState.RIGHT, myScriptTaskPane.getDockState()); Assert.assertTrue(myScriptTaskPane.isVisible()); Assert.assertEquals(300.0d, myScriptTaskPane.getWidth()); Assert.assertTrue(myScriptTaskPane.isLocked()); Assert.assertEquals(1, myScriptTaskPane.getRow()); webExtension = myScriptTaskPane.getWebExtension(); Assert.assertEquals("", webExtension.getId()); Assert.assertEquals("WA104380646", webExtension.getReference().getId()); Assert.assertEquals("1.0.0.0", webExtension.getReference().getVersion()); Assert.assertEquals(WebExtensionStoreType.OMEX, webExtension.getReference().getStoreType()); Assert.assertEquals("English (United States)", webExtension.getReference().getStore()); Assert.assertEquals(0, webExtension.getAlternateReferences().getCount()); Assert.assertEquals("MyScript", webExtension.getProperties().get(0).getName()); Assert.assertEquals("MyScript Math Sample", webExtension.getProperties().get(0).getValue()); Assert.assertEquals("MyScript", webExtension.getBindings().get(0).getId()); Assert.assertEquals(WebExtensionBindingType.TEXT, webExtension.getBindings().get(0).getBindingType()); Assert.assertEquals("104380646", webExtension.getBindings().get(0).getAppRef()); Assert.assertFalse(webExtension.isFrozen()); ``` **Returns:** boolean - The corresponding boolean value. ### isFrozen(boolean value) {#isFrozen-boolean} ``` public void isFrozen(boolean value) ``` Specifies whether the user can interact with the web extension or not. **Examples:** Shows how to add a web extension to a document. ``` Document doc = new Document(); // Create task pane with "MyScript" add-in, which will be used by the document, // then set its default location. TaskPane myScriptTaskPane = new TaskPane(); doc.getWebExtensionTaskPanes().add(myScriptTaskPane); myScriptTaskPane.setDockState(TaskPaneDockState.RIGHT); myScriptTaskPane.isVisible(true); myScriptTaskPane.setWidth(300.0); myScriptTaskPane.isLocked(true); // If there are multiple task panes in the same docking location, we can set this index to arrange them. myScriptTaskPane.setRow(1); // Create an add-in called "MyScript Math Sample", which the task pane will display within. WebExtension webExtension = myScriptTaskPane.getWebExtension(); // Set application store reference parameters for our add-in, such as the ID. webExtension.getReference().setId("WA104380646"); webExtension.getReference().setVersion("1.0.0.0"); webExtension.getReference().setStoreType(WebExtensionStoreType.OMEX); webExtension.getReference().setStore("English (United States)"); webExtension.getProperties().add(new WebExtensionProperty("MyScript", "MyScript Math Sample")); webExtension.getBindings().add(new WebExtensionBinding("MyScript", WebExtensionBindingType.TEXT, "104380646")); // Allow the user to interact with the add-in. webExtension.isFrozen(false); // We can access the web extension in Microsoft Word via Developer -> Add-ins. doc.save(getArtifactsDir() + "Document.WebExtension.docx"); // Remove all web extension task panes at once like this. doc.getWebExtensionTaskPanes().clear(); Assert.assertEquals(0, doc.getWebExtensionTaskPanes().getCount()); doc = new Document(getArtifactsDir() + "Document.WebExtension.docx"); myScriptTaskPane = doc.getWebExtensionTaskPanes().get(0); Assert.assertEquals(TaskPaneDockState.RIGHT, myScriptTaskPane.getDockState()); Assert.assertTrue(myScriptTaskPane.isVisible()); Assert.assertEquals(300.0d, myScriptTaskPane.getWidth()); Assert.assertTrue(myScriptTaskPane.isLocked()); Assert.assertEquals(1, myScriptTaskPane.getRow()); webExtension = myScriptTaskPane.getWebExtension(); Assert.assertEquals("", webExtension.getId()); Assert.assertEquals("WA104380646", webExtension.getReference().getId()); Assert.assertEquals("1.0.0.0", webExtension.getReference().getVersion()); Assert.assertEquals(WebExtensionStoreType.OMEX, webExtension.getReference().getStoreType()); Assert.assertEquals("English (United States)", webExtension.getReference().getStore()); Assert.assertEquals(0, webExtension.getAlternateReferences().getCount()); Assert.assertEquals("MyScript", webExtension.getProperties().get(0).getName()); Assert.assertEquals("MyScript Math Sample", webExtension.getProperties().get(0).getValue()); Assert.assertEquals("MyScript", webExtension.getBindings().get(0).getId()); Assert.assertEquals(WebExtensionBindingType.TEXT, webExtension.getBindings().get(0).getBindingType()); Assert.assertEquals("104380646", webExtension.getBindings().get(0).getAppRef()); Assert.assertFalse(webExtension.isFrozen()); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | boolean | The corresponding boolean value. | ### setId(String value) {#setId-java.lang.String} ``` public void setId(String value) ``` Uniquely identifies the web extension instance in the current document. **Examples:** Shows how to add a web extension to a document. ``` Document doc = new Document(); // Create task pane with "MyScript" add-in, which will be used by the document, // then set its default location. TaskPane myScriptTaskPane = new TaskPane(); doc.getWebExtensionTaskPanes().add(myScriptTaskPane); myScriptTaskPane.setDockState(TaskPaneDockState.RIGHT); myScriptTaskPane.isVisible(true); myScriptTaskPane.setWidth(300.0); myScriptTaskPane.isLocked(true); // If there are multiple task panes in the same docking location, we can set this index to arrange them. myScriptTaskPane.setRow(1); // Create an add-in called "MyScript Math Sample", which the task pane will display within. WebExtension webExtension = myScriptTaskPane.getWebExtension(); // Set application store reference parameters for our add-in, such as the ID. webExtension.getReference().setId("WA104380646"); webExtension.getReference().setVersion("1.0.0.0"); webExtension.getReference().setStoreType(WebExtensionStoreType.OMEX); webExtension.getReference().setStore("English (United States)"); webExtension.getProperties().add(new WebExtensionProperty("MyScript", "MyScript Math Sample")); webExtension.getBindings().add(new WebExtensionBinding("MyScript", WebExtensionBindingType.TEXT, "104380646")); // Allow the user to interact with the add-in. webExtension.isFrozen(false); // We can access the web extension in Microsoft Word via Developer -> Add-ins. doc.save(getArtifactsDir() + "Document.WebExtension.docx"); // Remove all web extension task panes at once like this. doc.getWebExtensionTaskPanes().clear(); Assert.assertEquals(0, doc.getWebExtensionTaskPanes().getCount()); doc = new Document(getArtifactsDir() + "Document.WebExtension.docx"); myScriptTaskPane = doc.getWebExtensionTaskPanes().get(0); Assert.assertEquals(TaskPaneDockState.RIGHT, myScriptTaskPane.getDockState()); Assert.assertTrue(myScriptTaskPane.isVisible()); Assert.assertEquals(300.0d, myScriptTaskPane.getWidth()); Assert.assertTrue(myScriptTaskPane.isLocked()); Assert.assertEquals(1, myScriptTaskPane.getRow()); webExtension = myScriptTaskPane.getWebExtension(); Assert.assertEquals("", webExtension.getId()); Assert.assertEquals("WA104380646", webExtension.getReference().getId()); Assert.assertEquals("1.0.0.0", webExtension.getReference().getVersion()); Assert.assertEquals(WebExtensionStoreType.OMEX, webExtension.getReference().getStoreType()); Assert.assertEquals("English (United States)", webExtension.getReference().getStore()); Assert.assertEquals(0, webExtension.getAlternateReferences().getCount()); Assert.assertEquals("MyScript", webExtension.getProperties().get(0).getName()); Assert.assertEquals("MyScript Math Sample", webExtension.getProperties().get(0).getValue()); Assert.assertEquals("MyScript", webExtension.getBindings().get(0).getId()); Assert.assertEquals(WebExtensionBindingType.TEXT, webExtension.getBindings().get(0).getBindingType()); Assert.assertEquals("104380646", webExtension.getBindings().get(0).getAppRef()); Assert.assertFalse(webExtension.isFrozen()); ``` **Parameters:** | Parameter | Type | Description | | --- | --- | --- | | value | java.lang.String | The corresponding java.lang.String value. |