ICustomDocumentPropertyCollection

Interface ICustomDocumentPropertyCollection

All Superinterfaces:

IDocumentPropertyCollection

---

public interface ICustomDocumentPropertyCollection extends IDocumentPropertyCollection

自定义文档属性的集合。

表示存储在工作簿中的自定义元数据。使用此集合可以添加、移除和访问应用程序定义的文档属性，例如文本、数值、Boolean、日期和链接内容属性。

 ICustomDocumentPropertyCollection properties = workbook.getCustomDocumentProperties();
 properties.add("Department", "Sales");
 properties.add("Revision", 3);
 String fileName = "CustomDocumentProperties.xlsx";
 workbook.save(fileName);
 

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  IDocumentProperty

  add(String name, boolean value)

  创建一个具有布尔值的新 IDocumentProperty，并将其添加到当前 Workbook 可用的自定义文档属性中。

  IDocumentProperty

  add(String name, double value)

  创建一个具有双精度浮点值的新 IDocumentProperty，并将其添加到当前 Workbook 的自定义文档属性中。

  IDocumentProperty

  add(String name, int value)

  创建一个具有整数值的新自定义文档属性，并将其添加到当前 Workbook。

  IDocumentProperty

  add(String name, String value)

  创建一个具有字符串值的新 IDocumentProperty，并将其添加到当前 Workbook 可用的自定义文档属性中。

  IDocumentProperty

  add(String name, Calendar value)

  创建一个具有日期值的新 IDocumentProperty，并将其添加到当前 Workbook 可用的自定义文档属性中。

  IDocumentProperty

  addLinkToContent(String name, String source)

  创建一个链接到工作簿内容的新 IDocumentProperty，并将其添加到当前 Workbook 的自定义文档属性中。

  Methods inherited from interface com.grapecity.documents.excel.IDocumentPropertyCollection

  clear, contains, get, get, getCount, indexOf, remove, removeAt

• Method Details

  • add

    IDocumentProperty add(String name, String value)

    创建一个具有字符串值的新 IDocumentProperty，并将其添加到当前 Workbook 可用的自定义文档属性中。

    
     IDocumentProperty property = workbook.getCustomDocumentProperties().add("Department", "Sales");
     

    Parameters:

    name - 新 IDocumentProperty 的名称。

    value - 属性的字符串值。

    Returns:

    新的 IDocumentProperty。

  • add

    IDocumentProperty add(String name, int value)

    创建一个具有整数值的新自定义文档属性，并将其添加到当前 Workbook。

    新属性会添加到 Workbook.getCustomDocumentProperties() 返回的集合中。

    
     IDocumentProperty property = workbook.getCustomDocumentProperties().add("Revision", 3);
     Object value = property.getValue();
     

    Parameters:

    name - 新 IDocumentProperty 的名称。

    value - 属性的整数值。

    Returns:

    新的 IDocumentProperty。

  • add

    IDocumentProperty add(String name, Calendar value)

    创建一个具有日期值的新 IDocumentProperty，并将其添加到当前 Workbook 可用的自定义文档属性中。

    
     Calendar publishedOn = Calendar.getInstance();
     publishedOn.set(2024, Calendar.JANUARY, 15, 0, 0, 0);
     publishedOn.set(Calendar.MILLISECOND, 0);
     IDocumentProperty property = workbook.getCustomDocumentProperties().add("PublishedOn", publishedOn);
     PropertyType type = property.getType();
     

    Parameters:

    name - 新 IDocumentProperty 的名称。

    value - 属性的日期值。

    Returns:

    新的 IDocumentProperty。

  • add

    IDocumentProperty add(String name, boolean value)

    创建一个具有布尔值的新 IDocumentProperty，并将其添加到当前 Workbook 可用的自定义文档属性中。

    
     IDocumentProperty property = workbook.getCustomDocumentProperties().add("IsReviewed", true);
     

    Parameters:

    name - 新 IDocumentProperty 的名称。

    value - 属性的布尔值。

    Returns:

    新的 IDocumentProperty。

  • add

    IDocumentProperty add(String name, double value)

    创建一个具有双精度浮点值的新 IDocumentProperty，并将其添加到当前 Workbook 的自定义文档属性中。

    
     IDocumentProperty property = workbook.getCustomDocumentProperties().add("Price", 19.95);
     PropertyType type = property.getType();
     

    Parameters:

    name - 新 IDocumentProperty 的名称。

    value - 属性的 double 值。

    Returns:

    新的 IDocumentProperty。

  • addLinkToContent

    IDocumentProperty addLinkToContent(String name, String source)

    创建一个链接到工作簿内容的新 IDocumentProperty，并将其添加到当前 Workbook 的自定义文档属性中。

    source 参数指定工作簿定义名称，例如命名区域。如果该定义名称引用多个单元格，则该属性使用左上角单元格的值。

    
     worksheet.getRange("A1").setValue("Sales");
     workbook.getNames().add("DepartmentCell", "=Sheet1!$A$1");
     IDocumentProperty property = workbook.getCustomDocumentProperties().addLinkToContent("Department", "DepartmentCell");
     String linkSource = property.getLinkSource();
     

    Parameters:

    name - 新 IDocumentProperty 的名称。

    source - 要将其引用内容链接到属性的工作簿定义名称，例如命名区域。

    Returns:

    新的 IDocumentProperty。