Method Details

• getId

  String getId()

  Gets the unique ID of the Custom XML part.

  The ID is generated when the part is added to the workbook and is stored in the Custom XML part properties. Use this value with ICustomXmlPartCollection.get(String) to retrieve the same part after the workbook is saved and reopened.

  
   ICustomXmlPart customXmlPart = workbook.getCustomXmlParts().add();
   String id = customXmlPart.getId();
  
   ICustomXmlPart samePart = workbook.getCustomXmlParts().get(id);
   

  Returns:

  The unique ID of the Custom XML part.

• getData

  byte[] getData()

  Gets the raw data stored in the Custom XML part.

  The returned byte array is a copy of the stored data. Modifying the returned array does not change the content of the Custom XML part. To update the part content, use setData(byte[]).

  
   ICustomXmlPart customXmlPart = workbook.getCustomXmlParts().add();
   byte[] xmlData = "<settings><enabled>true</enabled></settings>"
           .getBytes(java.nio.charset.StandardCharsets.UTF_8);
   customXmlPart.setData(xmlData);
  
   byte[] storedXmlData = customXmlPart.getData();
   String xmlText = new String(storedXmlData, java.nio.charset.StandardCharsets.UTF_8);
   

  Returns:

  The raw Custom XML part data.

• setData

  void setData(byte[] data)

  Sets the raw data stored in the Custom XML part.

  The provided byte array is copied into the Custom XML part. The data is persisted as the XML payload of the part when the workbook is saved to an OpenXML workbook format.

  
   ICustomXmlPart customXmlPart = workbook.getCustomXmlParts().add();
   byte[] xmlData = "<settings><enabled>true</enabled></settings>"
           .getBytes(java.nio.charset.StandardCharsets.UTF_8);
   customXmlPart.setData(xmlData);
   workbook.save("customXmlWorkbook.xlsx");
   

  Parameters:

  data - The raw Custom XML part data.