TaskPaneDockState
Contents
[
Hide
]Inheritance: java.lang.Object
public class TaskPaneDockState
Enumerates available locations of task pane object.
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 |
|---|---|
| LEFT | Dock the task pane on the left side of the document window. |
| RIGHT | Dock the task pane on the right side of the document window. |
| length |
Methods
| Method | Description |
|---|---|
| fromName(String taskPaneDockStateName) | |
| getName(int taskPaneDockState) | |
| getValues() | |
| toString(int taskPaneDockState) |
LEFT
public static int LEFT
Dock the task pane on the left side of the document window.
RIGHT
public static int RIGHT
Dock the task pane on the right side of the document window.
length
public static int length
fromName(String taskPaneDockStateName)
public static int fromName(String taskPaneDockStateName)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| taskPaneDockStateName | java.lang.String |
Returns: int
getName(int taskPaneDockState)
public static String getName(int taskPaneDockState)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| taskPaneDockState | int |
Returns: java.lang.String
getValues()
public static int[] getValues()
Returns: int[]
toString(int taskPaneDockState)
public static String toString(int taskPaneDockState)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| taskPaneDockState | int |
Returns: java.lang.String
