org.ttzero.excel.manager.docProps

类 CustomProperties

java.lang.Object

org.ttzero.excel.manager.docProps.XmlEntity

org.ttzero.excel.manager.docProps.CustomProperties

所有已实现的接口:

Storable

@TopNS(prefix={"","vt"},
       uri={"http://schemas.openxmlformats.org/officeDocument/2006/custom-properties","http://schemas.openxmlformats.org/officeDocument/2006/docPropsVTypes"},
       value="Properties")
public class CustomProperties
extends XmlEntity

自定义属性

注意：只支持"文本"、"数字"、"日期"以及"布尔值"，其它数据类型将使用toString强转换为文本

从以下版本开始:

2024-09-19

作者:

guanquan.wang

字段概要

字段

限定符和类型	字段和说明
static String	FORMAT_ID 自定义属性的GUID值{D5CDD505-2E9C-101B-9397-08002B2CF9AE}

构造器概要

构造器

构造器和说明
CustomProperties()

方法概要

限定符和类型	方法和说明
protected static void	check(String key, Object val) 检查属性的合法性
static CustomProperties	domToCustom(org.dom4j.Element root) Dom转Custom对象
Object	get(String key) 获取自定义属性的值
Map<String,Object>	getAll() 获取所有自定义属性的副本
boolean	hasProperty() 测试是否包含自定义属性
boolean	hasReadOnlyMark() 判断文档是否受为只读
void	markAsReadOnly() 文档保护-只读标记
void	put(String key, Object value) 将指定的键值对添加到属性集合中
void	putAll(Map<String,Object> properties) 将指定的属性集合添加到当前对象中
Object	remove(String key) 移除指定属性
protected static int	testValueType(Object val) 检查属性值的类型

从类继承的方法 org.ttzero.excel.manager.docProps.XmlEntity

writeTo

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

FORMAT_ID

public static final String FORMAT_ID

自定义属性的GUID值{D5CDD505-2E9C-101B-9397-08002B2CF9AE}

另请参阅:

常量字段值

构造器详细资料

CustomProperties

public CustomProperties()

方法详细资料

put

public void put(String key,
                Object value)

将指定的键值对添加到属性集合中

参数:

key - 属性的键名

value - 属性的值

putAll

public void putAll(Map<String,Object> properties)

将指定的属性集合添加到当前对象中

参数:

properties - 属性名称和值的映射表

markAsReadOnly

public void markAsReadOnly()

文档保护-只读标记

hasReadOnlyMark

public boolean hasReadOnlyMark()

判断文档是否受为只读

返回:

true: 工作表为只读

remove

public Object remove(String key)

移除指定属性

参数:

key - 指定需要移除的Key

返回:

如果Key存在则返回对应的值否则返回 null

getAll

public Map<String,Object> getAll()

获取所有自定义属性的副本

返回:

自定义属性列表

get

public Object get(String key)

获取自定义属性的值

参数:

key - 属性Key

返回:

如果Key存在则返回对应的值否则返回 null

hasProperty

public boolean hasProperty()

测试是否包含自定义属性

返回:

true: 包含自定义属性

domToCustom

public static CustomProperties domToCustom(org.dom4j.Element root)

Dom转Custom对象

参数:

root - dom树

返回:

Custom对象

check

protected static void check(String key,
                            Object val)

检查属性的合法性

参数:

key - 属性名

val - 属性值

testValueType

protected static int testValueType(Object val)

检查属性值的类型

参数:

val - 外部属性值

返回:

内部属性值 v1: 原值 v2：类型