Removing an Object from a Word Document in Java

Cloudmersive

Jan 29·2 min read

In previous posts, we shared how to use the Begin Editing and Finish Editing functions to open and close an online document. Today, we will share how to remove an object from a document you opened for modification; this applies to paragraphs, tables, images, etc. Before we dig into the process, be sure you have the object path handy to plug into the request configuration.

To kick things off, install the Maven SDK by adding a reference to the repository in pom.xml:

<repositories>
    <repository>
        <id>jitpack.io</id>
        <url>https://jitpack.io</url>
    </repository>
</repositories>

Then, add a reference to the dependency:

<dependencies>
<dependency>
    <groupId>com.github.Cloudmersive</groupId>
    <artifactId>Cloudmersive.APIClient.Java</artifactId>
    <version>v3.54</version>
</dependency>
</dependencies>

Now we are ready to call the remove object function with the following code:

// Import classes:
//import com.cloudmersive.client.invoker.ApiClient;
//import com.cloudmersive.client.invoker.ApiException;
//import com.cloudmersive.client.invoker.Configuration;
//import com.cloudmersive.client.invoker.auth.*;
//import com.cloudmersive.client.EditDocumentApi;ApiClient defaultClient = Configuration.getDefaultApiClient();// Configure API key authorization: Apikey
ApiKeyAuth Apikey = (ApiKeyAuth) defaultClient.getAuthentication("Apikey");
Apikey.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Apikey.setApiKeyPrefix("Token");EditDocumentApi apiInstance = new EditDocumentApi();
DocxRemoveObjectRequest reqConfig = new DocxRemoveObjectRequest(); // DocxRemoveObjectRequest | Document input request
try {
    DocxRemoveObjectResponse result = apiInstance.editDocumentDocxRemoveObject(reqConfig);
    System.out.println(result);
} catch (ApiException e) {
    System.err.println("Exception when calling EditDocumentApi#editDocumentDocxRemoveObject");
    e.printStackTrace();
}

To close out editing of your document, be sure to leverage our Finish Editing API (see previous post) to download and save your changes.