IVPageBreaks

Interface IVPageBreaks

All Superinterfaces:

Iterable<IVPageBreak>

---

public interface IVPageBreaks extends Iterable<IVPageBreak>

表示打印区域内垂直分页符的集合。

使用此集合可以在工作表上添加、访问和迭代垂直分页符。通过此集合添加的垂直分页符会定位在指定区域的左侧。

 worksheet.getRange("A1:F10").setValue("Data");
 IVPageBreaks pageBreaks = worksheet.getVPageBreaks();
 pageBreaks.add(worksheet.getRange("D1"));
 IVPageBreak pageBreak = pageBreaks.get(0);
 

• Method Summary

  All MethodsInstance MethodsAbstract Methods

  Modifier and Type

  Method

  Description

  IVPageBreak

  add(IRange before)

  在打印区域内添加垂直分页符。

  IVPageBreak

  get(int index)

  获取集合中指定索引处的 IVPageBreak。

  int

  getCount()

  返回集合中的对象数量。

  Methods inherited from interface java.lang.Iterable

  forEach, iterator, spliterator

• Method Details

  • getCount

    int getCount()

    返回集合中的对象数量。

    此方法返回打印区域内此集合包含的垂直分页符数量。

    
     IVPageBreaks pageBreaks = worksheet.getVPageBreaks();
     pageBreaks.add(worksheet.getRange("C1"));
     pageBreaks.add(worksheet.getRange("F1"));
     int count = pageBreaks.getCount();
     

    Returns:

    集合中的对象数量。

  • get

    IVPageBreak get(int index)

    获取集合中指定索引处的 IVPageBreak。

    使用此方法访问已通过 add(IRange) 或其他工作表分页符操作添加到工作表打印区域的垂直分页符。

    
     worksheet.getRange("A1:F3").setValue(new Object[][] {
         {"Name", "Q1", "Q2", "Q3", "Q4", "Total"},
         {"North", 100, 120, 110, 130, 460}
     });
     IVPageBreaks pageBreaks = worksheet.getVPageBreaks();
     pageBreaks.add(worksheet.getRange("D1"));
     IVPageBreak pageBreak = pageBreaks.get(0);
     IRange location = pageBreak.getLocation();
     

    Parameters:

    index - 集合的索引。

    Returns:

    指定索引处的 IVPageBreak 对象。

  • add

    IVPageBreak add(IRange before)

    在打印区域内添加垂直分页符。

    分页符与指定区域的左边缘对齐。

    
     worksheet.getRange("A1:H2").setValue(new Object[][] {
         {"Name", "Q1", "Q2", "Q3", "Q4", "Total", "Region", "Status"},
         {"Test", 100, 120, 140, 160, 520, "East", "Open"}
     });
     IVPageBreak pageBreak = worksheet.getVPageBreaks().add(worksheet.getRange("F2"));
     

    Parameters:

    before - 其左边缘定义新分页符添加位置的区域。如果 before 为 null，则不添加分页符。

    Returns:

    新的 IVPageBreak 对象，或 null（如果 before 为 null）。

    Throws:

    IllegalArgumentException - 如果 before 从工作表第一列开始。

    IllegalStateException - 如果已达到垂直分页符的最大数量。