Work with Office Add-ins

Sometimes you might want to give access to interface controls that run code to modify documents. Aspose.Words API provides the WebExtensions namespace, which grants various classes to customize elements and attributes extending the XML vocabulary for representing Office Add-ins.

WebExtensions namespace can be conditionally divided into:

• Objects for working with the task pane
• Objects for working with web extensions

Using Task Panes

The task panes are interface surfaces that are displayed on the right side of the window in Microsoft Word. Task pane allows users to access interface controls that can run code to modify documents.

For example, using Aspose.Words API, you can add a task pane add‑in and customize its appearance.

Using Web Extensions

Web Extensions are tools that expand the capabilities of Office applications and interact with Office document content. Web Extensions provide additional functionality to Office clients for improving user experience.

Aspose.Words provides the ability to add Web Extensions of the Task Pane type using the WebExtension and TaskPane classes, and also allows you to customize the pane and extension properties.

The following code example shows how to create task panes and add to web extension task panes with basic properties:

To see a list of task pane add‑ins, use the get_WebExtensionTaskPanes() property.

The following code example shows how to get such a list of add‑ins:

---

FAQ

1. Q: How do I add a task pane add‑in to a Word document using C++?
   A: Create a TaskPane, add it to the document with Document::get_WebExtensionTaskPanes()->Add, and set its properties (e.g., TaskPane::set_DockState, TaskPane::set_IsVisible, TaskPane::set_Width). Then configure the add-in through TaskPane::get_WebExtension() (for example, its WebExtension::get_Reference() Id, Store and get_StoreType()). The API handles the underlying XML for the Office add‑in.

2. Q: How can I retrieve the list of task pane add‑ins that are already attached to a document?
   A: Use Document::get_WebExtensionTaskPanes(), which returns a TaskPaneCollection of TaskPane objects. Iterate over the collection to read properties such as TaskPane::get_DockState, TaskPane::get_IsVisible, and TaskPane::get_WebExtension.

3. Q: Which properties can I customize for a task pane when creating it?
   A: You can set set_DockState(), set_IsVisible(), Width, Row, and get_IsLocked() on the TaskPane object; the add-in itself (Id, Store, get_StoreType()) is set through TaskPane::get_WebExtension()->get_Reference(). These values control how the pane appears in Word and whether it is shown by default.

4. Q: Do I need a license to use the WebExtensions API in Aspose.Words for C++?
   A: Yes. All Aspose.Words features, including WebExtensions, require a valid Aspose.Words for C++ license. Apply the license at the start of your application using auto license = System::MakeObject<Aspose::Words::License>(); license->SetLicense(u"Aspose.Words.CPP.lic");.

5. Q: Can I add multiple task pane add‑ins to the same document?
   A: Absolutely. Create a separate TaskPane for each add‑in, add each one to Document::get_WebExtensionTaskPanes(), and configure the add‑in of each pane through its own TaskPane::get_WebExtension(). Each pane will appear as an individual task pane in Word.