前言:
Spire.Cloud 在线编辑器是一款基于网页的 Office 文件编辑工具,支持在网页中打开、编辑、打印 Word、Excel、PPT 文件,支持将文档保存到私有云盘。支持 IE、Chrome、FireFox、搜狗、遨游、360 等常见浏览器。Spire.Cloud Web API 能帮助开发人员能在任何时间、任何地点直接调用 SDK 接口对 Word、Excel、PPT、PDF 文档进行操作。Spire.Cloud 支持 .NET、Java、PHP、Python、JavaScript 等多种编程语言,并提供了 1 万次的免费调用次数及 2G 文档内存。
本文将通过实例阐述如何通过Spire.Cloud.Word API给开发人员提供的DocumentPropertiesApi接口,来添加、获取和删除Word文档自定义属性。
详细步骤:
1、通过冰蓝云官网( https://cloud.e-iceblue.cn/)注册账号并登陆,在“我的应用”版块创建应用程序,获得App ID及App Key。
2、上传Word文档至冰蓝云官网的“文档管理”版块。为了便于文档管理,您也可以先创建文件夹“input”和“output”,然后将需要编辑的Word文档上传至input文件夹下,output文件夹用于存放生成的文档。
3、创建Maven应用程序,通过Maven仓库安装Spire.Cloud.SDK jar包及依赖。详细步骤参考 文章 。
<repositories>
<repository>
<id>com.e-iceblue</id>
<name>cloud</name>
<url>http://repo.e-iceblue.cn/repository/maven-public/</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId> cloud </groupId>
<artifactId>spire.cloud.sdk</artifactId>
<version>3.5.0</version>
</dependency>
<dependency>
<groupId>io.swagger</groupId>
<artifactId>swagger-annotations</artifactId>
<version>1.5.18</version>
</dependency>
<dependency>
<groupId>com.squareup.okhttp</groupId>
<artifactId>okhttp</artifactId>
<version>2.7.5</version>
</dependency>
<dependency>
<groupId>com.squareup.okhttp</groupId>
<artifactId>logging-interceptor</artifactId>
<version>2.7.5</version>
</dependency>
<dependency>
<groupId> com.squareup.okio </groupId>
<artifactId>okio</artifactId>
<version>1.6.0</version>
</dependency>
<dependency>
<groupId>com.google.code.gson</groupId>
<artifactId>gson</artifactId>
<version>2.8.1</version>
</dependency>
<dependency>
<groupId>io.gsonfire</groupId>
<artifactId>gson-fire</artifactId>
<version>1.8.0</version>
</dependency>
<dependency>
<groupId>org.threeten</groupId>
<artifactId>threetenbp</artifactId>
<version>1.3.5</version>
</dependency>
</dependencies>
4、新建Java class,输入Java代码来实现添加、获取和删除 Word 文档自定义属性。
示例1、添加自定义文档属性
import spire.cloud.word.sdk.client.*;
import spire.cloud.word.sdk.client.api.DocumentPropertiesApi;
import spire.cloud.word.sdk.client.model.*;
import java.util.ArrayList;
import java.util.List;
public class addCustomDocumentProperties {
static String appId = " APP ID ";
static String appKey = " APP Key ";
static String baseUrl = "https://api.e-iceblue.cn";
//配置APP ID和APP Key
static Configuration wordConfiguration = new Configuration(appId, appKey, baseUrl);
//创建documentPropertiesApi实例
static DocumentPropertiesApi documentPropertiesApi = new DocumentPropertiesApi(wordConfiguration);
public static void main(String[] args) throws ApiException {
//示例文档名称
String name = "test.docx";
//示例文档的密码
String password = null;
//存放示例文档的文件夹
String folder = "input";
//使用冰蓝云默认的存储空间
String storage = null;
//输出文档存放路径
String destFilePath = "output/addCustomDocumentProperties_out.docx";
//设置自定义文档属性
List properties = new ArrayList();
properties.add(new CustomDocumentProperty("Name1", "Value1"));
properties.add(new CustomDocumentProperty("Name2", "Value2"));
//调用addCustomDocumentProperties添加自定义文档属性
documentPropertiesApi.addCustomDocumentProperties(name, properties, destFilePath, password, folder, storage);
}
}
示例2、获取自定义文档属性
import spire.cloud.word.sdk.client.*;
import spire.cloud.word.sdk.client.api.DocumentPropertiesApi;
import spire.cloud.word.sdk.client.model.*;
import java.util.List;
public class getCustomDocumentProperties {
static String appId = " APP ID ";
static String appKey = " APP Key ";
static String baseUrl = "https://api.e-iceblue.cn";
//配置APP ID和APP Key
static Configuration wordConfiguration = new Configuration(appId, appKey, baseUrl);
//创建documentPropertiesApi实例
static DocumentPropertiesApi documentPropertiesApi = new DocumentPropertiesApi(wordConfiguration);
public static void main(String[] args) throws ApiException {
//示例文档名称
String name = "Sample.docx";
//示例文档的密码
String password = null;
//存放示例文档的文件夹
String folder = "input";
//使用冰蓝云默认的存储空间
String storage = null;
//调用getCustomDocumentProperties读取自定义文档属性
List response = documentPropertiesApi.getCustomDocumentProperties(name, password, folder, storage);
System.out.println(response);
}
}
示例3、删除自定义文档属性
import spire.cloud.word.sdk.client.*;
import spire.cloud.word.sdk.client.api.DocumentPropertiesApi;
public class deleteCustomDocumentProperties {
static String appId = " APP ID ";
static String appKey = " APP Key ";
static String baseUrl = "https://api.e-iceblue.cn";
//配置APP ID和APP Key
static Configuration wordConfiguration = new Configuration(appId, appKey, baseUrl);
//创建documentPropertiesApi实例
static DocumentPropertiesApi documentPropertiesApi = new DocumentPropertiesApi(wordConfiguration);
public static void main(String[] args) throws ApiException {
//示例文档名称
String name = "Sample.docx";
//示例文档自定义属性中需要删除的项目
String propertieName = "Owner";
//示例文档的密码
String password = null;
//存放示例文档的文件夹
String folder = "input";
//使用冰蓝云默认的存储空间
String storage = null;
//输出文档存放路径
String destFilePath = "output/deleteCustomDocumentProperties_output.docx";
//调用deleteCustomDocumentProperty删除指定的自定义文档属性
documentPropertiesApi.deleteCustomDocumentProperty(name, propertieName, destFilePath, password, folder, storage);
}
}