WebExtensionBindingType
Contents
[
Hide
]Inheritance: java.lang.Object
public class WebExtensionBindingType
Enumerates available types of binding between a web extension and the data in the 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());
Fields
| Field | Description |
|---|---|
| DEFAULT | Matrix used by default. |
| MATRIX | Tabular data without a header row. |
| TABLE | Tabular data with a header row. |
| TEXT | Plain text. |
| length |
Methods
| Method | Description |
|---|---|
| fromName(String webExtensionBindingTypeName) | |
| getName(int webExtensionBindingType) | |
| getValues() | |
| toString(int webExtensionBindingType) |
DEFAULT
public static int DEFAULT
Matrix used by default.
MATRIX
public static int MATRIX
Tabular data without a header row.
TABLE
public static int TABLE
Tabular data with a header row.
TEXT
public static int TEXT
Plain text.
length
public static int length
fromName(String webExtensionBindingTypeName)
public static int fromName(String webExtensionBindingTypeName)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| webExtensionBindingTypeName | java.lang.String |
Returns: int
getName(int webExtensionBindingType)
public static String getName(int webExtensionBindingType)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| webExtensionBindingType | int |
Returns: java.lang.String
getValues()
public static int[] getValues()
Returns: int[]
toString(int webExtensionBindingType)
public static String toString(int webExtensionBindingType)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| webExtensionBindingType | int |
Returns: java.lang.String
