WebExtension
Inheritance: java.lang.Object
public class WebExtension
Represents a web extension object.
To learn more, visit the 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());
Methods
| Method | Description |
|---|---|
| getAlternateReferences() | Specifies alternate references to a web extension. |
| getBindings() | Specifies a list of web extension bindings. |
| getId() | Uniquely identifies the web extension instance in the current document. |
| getProperties() | Represents a set of web extension custom properties. |
| getReference() | Specifies the primary reference to an web extension. |
| isFrozen() | Specifies whether the user can interact with the web extension or not. |
| isFrozen(boolean value) | Specifies whether the user can interact with the web extension or not. |
| setId(String value) | Uniquely identifies the web extension instance in the current document. |
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 - The corresponding WebExtensionReferenceCollection value.
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 - The corresponding WebExtensionBindingCollection value.
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()
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 - The corresponding WebExtensionPropertyCollection value.
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 - The corresponding WebExtensionReference value.
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)
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)
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. |
