WebExtension Class

Represents a web extension object.

Inheritance Hierarchy

SystemObject
  Aspose.Words.WebExtensionsWebExtension

Namespace:  Aspose.Words.WebExtensions
Assembly:  Aspose.Words (in Aspose.Words.dll) Version: 20.7.0

Syntax

public class WebExtension

The WebExtension type exposes the following members.

Properties

  NameDescription
Public propertyAlternateReferences
Specifies alternate references to a web extension.
Public propertyCode exampleBindings
Specifies a list of web extension bindings.
Public propertyId
Uniquely identifies the web extension instance in the current document.
Public propertyCode exampleIsFrozen
Specifies whether the user can interact with the web extension or not.
Public propertyCode exampleProperties
Represents a set of web extension custom properties.
Public propertyCode exampleReference
Specifies the primary reference to an web extension.

Methods

  NameDescription
Public methodEquals (Inherited from Object.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodToString (Inherited from Object.)

Examples

Shows how to create add-ins inside the document.
Document doc = new Document();

// Create taskpane with "MyScript" add-in which will be used by the document
TaskPane myScriptTaskPane = new TaskPane();
doc.WebExtensionTaskPanes.Add(myScriptTaskPane);

// Define task pane location when the document opens
myScriptTaskPane.DockState = TaskPaneDockState.Right;
myScriptTaskPane.IsVisible = true;
myScriptTaskPane.Width = 300;
myScriptTaskPane.IsLocked = true;
// Use this option if you have several task panes
myScriptTaskPane.Row = 1;

// Add "MyScript Math Sample" add-in which will be displayed inside task pane
WebExtension webExtension = myScriptTaskPane.WebExtension;

// Application Id from store
webExtension.Reference.Id = "WA104380646";
// The current version of the application used
webExtension.Reference.Version = "1.0.0.0";
// Type of marketplace
webExtension.Reference.StoreType = WebExtensionStoreType.OMEX;
// Marketplace based on your locale
webExtension.Reference.Store = CultureInfo.CurrentCulture.Name;

webExtension.Properties.Add(new WebExtensionProperty("MyScript", "MyScript Math Sample"));
webExtension.Bindings.Add(new WebExtensionBinding("MyScript", WebExtensionBindingType.Text, "104380646"));

// Use this option if you need to block web extension from any action
webExtension.IsFrozen = false;

doc.Save(ArtifactsDir + "Document.WebExtension.docx");

See Also