com.aspose.words

Class WebExtensionStoreType

java.lang.Object

com.aspose.words.WebExtensionStoreType

public class WebExtensionStoreType
extends java.lang.Object

Enumerates available types of a web extension store.

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());
 
 

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT Default value.
static int	EX_CATALOG Specifies that the store type is Centralized Deployment via Exchange.
static int	EXCHANGE Specifies that the store type is an Exchange server.
static int	FILE_SYSTEM Specifies that the store type is a file system share.
static int	length
static int	OMEX Specifies that the store type is Office.com.
static int	REGISTRY Specifies that the store type is the system registry.
static int	SP_APP
static int	SP_CATALOG

Method Summary

Modifier and Type	Method and Description
static int	fromName(java.lang.String webExtensionStoreTypeName)
static java.lang.String	getName(int webExtensionStoreType)
static int[]	getValues()
static java.lang.String	toString(int webExtensionStoreType)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SP_CATALOG

public static int SP_CATALOG

OMEX

public static int OMEX

Specifies that the store type is Office.com.

SP_APP

public static int SP_APP

EXCHANGE

public static int EXCHANGE

Specifies that the store type is an Exchange server.

FILE_SYSTEM

public static int FILE_SYSTEM

Specifies that the store type is a file system share.

REGISTRY

public static int REGISTRY

Specifies that the store type is the system registry.

EX_CATALOG

public static int EX_CATALOG

Specifies that the store type is Centralized Deployment via Exchange.

DEFAULT

public static int DEFAULT

Default value.

length

public static int length

Method Detail

getName

public static java.lang.String getName(int webExtensionStoreType)

toString

public static java.lang.String toString(int webExtensionStoreType)

fromName

public static int fromName(java.lang.String webExtensionStoreTypeName)

getValues

public static int[] getValues()