com.aspose.words

Class WebExtensionStoreType

  • java.lang.Object
    • com.aspose.words.WebExtensionStoreType
public class WebExtensionStoreType 
extends java.lang.Object

Utility class containing constants. Enumerates available types of a web extension store.

Example:

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

Field Summary
static final intSP_CATALOG = 0
Specifies that the store type is SharePoint corporate catalog.
static final intOMEX = 1
Specifies that the store type is Office.com.
static final intSP_APP = 2
Specifies that the store type is a SharePoint web application.
static final intEXCHANGE = 3
Specifies that the store type is an Exchange server.
static final intFILE_SYSTEM = 4
Specifies that the store type is a file system share.
static final intREGISTRY = 5
Specifies that the store type is the system registry.
static final intEX_CATALOG = 6
Specifies that the store type is Centralized Deployment via Exchange.
static final intDEFAULT = 0
Default value.
 

    • Field Detail

      • SP_CATALOG = 0

        public static final int SP_CATALOG
        Specifies that the store type is SharePoint corporate catalog.
      • OMEX = 1

        public static final int OMEX
        Specifies that the store type is Office.com.
      • SP_APP = 2

        public static final int SP_APP
        Specifies that the store type is a SharePoint web application.
      • EXCHANGE = 3

        public static final int EXCHANGE
        Specifies that the store type is an Exchange server.
      • FILE_SYSTEM = 4

        public static final int FILE_SYSTEM
        Specifies that the store type is a file system share.
      • REGISTRY = 5

        public static final int REGISTRY
        Specifies that the store type is the system registry.
      • EX_CATALOG = 6

        public static final int EX_CATALOG
        Specifies that the store type is Centralized Deployment via Exchange.
      • DEFAULT = 0

        public static final int DEFAULT
        Default value.