How to add a custom graphic to the Word document header

Question

I want to add a horizontal line to the header, which is drawn with word custom graphics.

1.For example, the following effect:

No custom graphics were added to the header: enter image description here

Add a horizontal line to the header: enter image description here

2.Unzip them separately and get the .xml file for the header:

There are no custom graphics in the header


    
        
        
        
        
            
            
        
    
    
        
            
            
        
        This is a header

There are custom graphics in the header




    
        
        
        
        
            
            
        
    
    
        
            
            
            
        
        T
    
    
        
            
            
        
        his is a header
    




    
        
        
        
        
            
            
        
    
    
    
        
            
            
            
            
        
        
            
                
                    
                    
                    
                        0
                    
                    
                        10795
                    
                    
                    
                    
                    
                    
                    
                    
                        
                            
                                
                                    
                                
                                
                                    
                                        
                                        
                                    
                                    
                                        
                                    
                                    
                                    
                                        
                                            
                                        
                                        
                                        
                                        
                                    
                                    
                                        
                                        
                                            
                                        
                                        
                                    
                                
                                
                            
                        
                    
                    
                        0
                    
                    
                        0

I did some common sense, but I found that I always can't solve the id problem of custom graphics, I hope you can help me, thank you!

Axel Richter · Accepted Answer

Until now (apache poi 5.0.0) creation of shapes in Word is not supported by apache poi. Only inserting of pictures is supported. There is not even a possibility to handle the namespace markup-compatibility (mc). So also using the underlying low level org.openxmlformats.schemas.wordprocessingml.x2006.main.* classes it is not possible. Only directly manipulating the XML wold be possible. But this is too less straight forward.

What one could do is using the old shape definitions of com.microsoft.schemas.vml.*. These are currently still supported, even if they get replaced by the new drawing layer shapes.

Using com.microsoft.schemas.vml.* shapes are created using shape types which describe the shape by VML paths. Those shapes are placed in pict elements in text runs of document and/or header/footer.

A line shape in a header could be created as so:

import java.io.FileOutputStream;

import org.apache.poi.xwpf.usermodel.*;
import org.apache.poi.wp.usermodel.HeaderFooterType;

import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTR;
import org.openxmlformats.schemas.wordprocessingml.x2006.main.CTPicture;

import com.microsoft.schemas.vml.CTGroup;
import com.microsoft.schemas.vml.CTShape;
import com.microsoft.schemas.vml.CTShapetype;

import org.w3c.dom.Node;

public class CreateWordLineInHeader {

 public static void main(String[] args) throws Exception {

  XWPFDocument doc= new XWPFDocument();

  // the body content
  XWPFParagraph paragraph = doc.createParagraph();
  XWPFRun run=paragraph.createRun();  
  run.setText("The Body:");

  paragraph = doc.createParagraph();
  run=paragraph.createRun();  
  run.setText("Lorem ipsum....");

  // create header start
  XWPFHeader header = doc.createHeader(HeaderFooterType.DEFAULT);

  paragraph = header.getParagraphArray(0);
  if (paragraph == null) paragraph = header.createParagraph();
  paragraph.setAlignment(ParagraphAlignment.CENTER);
  run = paragraph.createRun(); 
  run.setText("This is a header");

  // paragraph for the line
  paragraph = header.createParagraph();
  paragraph.setAlignment(ParagraphAlignment.CENTER);
  run = paragraph.createRun(); 

  // create line shape in run
  CTGroup ctGroup = CTGroup.Factory.newInstance();

  String shapeTypeId = "_x0000_t123";
  CTShapetype shapetype = ctGroup.addNewShapetype();
  shapetype.setId(shapeTypeId);
  shapetype.setCoordsize("21600,21600");
  shapetype.setSpt(123);
  shapetype.setPath2("m,l21600,21600e");

  CTShape ctShape = ctGroup.addNewShape();
  ctShape.setType("#"+shapeTypeId);
  ctShape.setStyle("position:absolute;left:100pt;width:280pt;height:0");

  Node ctGroupNode = ctGroup.getDomNode(); 
  CTPicture ctPicture = CTPicture.Factory.parse(ctGroupNode);
  CTR cTR = run.getCTR();
  cTR.addNewPict();
  cTR.setPictArray(0, ctPicture);

  // create header end

  // create footer start
  XWPFFooter footer = doc.createFooter(HeaderFooterType.DEFAULT);

  paragraph = footer.getParagraphArray(0);
  if (paragraph == null) paragraph = footer.createParagraph();
  paragraph.setAlignment(ParagraphAlignment.CENTER);

  run = paragraph.createRun();  
  run.setText("The Footer");

  // create footer end

  FileOutputStream out = new FileOutputStream("CreateWordLineInHeader.docx");
  doc.write(out);
  out.close();
  doc.close();

 }
}

But is the line shape really necessary? If only a horizontal rule (like a HR in HTML) is needed, then a paragraph having a bottom border line would be much more straigt forward. See Word autoformat with Apache-POI.

How to add a custom graphic to the Word document header

1.For example, the following effect:

2.Unzip them separately and get the .xml file for the header:

Answers (1)

Related Questions