Merge pull request #82 from devlights/issue-81

Add PageBreak functions

Author: devlights

cell.go

@@ -169,3 +169,12 @@ func (c *Cell) SetNumberFormatLocal(format constants.NumberFormatLocal) error {
 
 	return nil
 }
+
+func (c *Cell) PageBreak(pageBreakType constants.XlPageBreak) error {
+	_, err := oleutil.PutProperty(c.ComObject(), "PageBreak", int(pageBreakType))
+	if err != nil {
+		return err
+	}
+
+	return err
+}

cell_test.go

@@ -9,6 +9,39 @@ import (
 	"github.com/devlights/goxcel/testutil"
 )
 
+func TestCell_PageBreak(t *testing.T) {
+	quit := MustInitGoxcel()
+	defer quit()
+
+	excel, release := MustNewGoxcel()
+	defer release()
+
+	_ = excel.SetVisible(true)
+
+	wbs := excel.MustWorkbooks()
+	wb, wbr := wbs.MustAdd()
+	defer wbr()
+
+	ws := wb.MustSheets(1)
+
+	rows := []int{2, 4, 6, 8, 10}
+	for _, row := range rows {
+		cell, _ := ws.Cells(row, 5)
+
+		err := cell.PageBreak(constants.XlPageBreakManual)
+		if err != nil {
+			t.Error(err)
+		}
+
+		cell.MustSetValue("hello")
+	}
+
+	hpb, _ := ws.HPageBreaks()
+	if count, _ := hpb.Count(); int(count) != len(rows) {
+		t.Errorf("[want] 5\t[got] %v", count)
+	}
+}
+
 func TestCell_End(t *testing.T) {
 	f := MustInitGoxcel()
 	defer f()

constants/xlPageBreak.go

@@ -0,0 +1,16 @@
+package constants
+
+type (
+	// XlPageBreak は、ワークシートのページブレークの場所を指定します。
+	XlPageBreak int
+)
+
+//goland:noinspection ALL
+const (
+	// Excel が自動的に改ページを追加します。
+	XlPageBreakAutomatic XlPageBreak = -4105
+	// 改ページは手動で挿入されます。
+	XlPageBreakManual XlPageBreak = -4135
+	// 改ページはワークシートに挿入されません。
+	XlPageBreakNone XlPageBreak = -4142
+)

range.go

@@ -203,6 +203,13 @@ func (r *XlRange) SetValue(value interface{}) error {
 	return nil
 }
 
+func (r *XlRange) MustSetValue(value any) {
+	err := r.SetValue(value)
+	if err != nil {
+		panic(err)
+	}
+}
+
 func (r *XlRange) SetNumberFormatLocal(format constants.NumberFormatLocal) error {
 	_, err := oleutil.PutProperty(r.ComObject(), "NumberFormatLocal", string(format))
 	if err != nil {
@@ -212,6 +219,15 @@ func (r *XlRange) SetNumberFormatLocal(format constants.NumberFormatLocal) error
 	return nil
 }
 
+func (r *XlRange) PageBreak(pageBreakType constants.XlPageBreak) error {
+	_, err := oleutil.PutProperty(r.ComObject(), "PageBreak", int(pageBreakType))
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
 func (r *XlRange) Walk(walkFn func(r *XlRange, c *Cell, row, col int) error) (*Cell, error) {
 	rows, err := r.Rows()
 	if err != nil {

range_test.go

@@ -1,10 +1,42 @@
 package goxcel
 
 import (
+	"github.com/devlights/goxcel/constants"
 	"github.com/devlights/goxcel/testutil"
 	"testing"
 )
 
+func TestXlRange_PageBreak(t *testing.T) {
+	quit := MustInitGoxcel()
+	defer quit()
+
+	excel, release := MustNewGoxcel()
+	defer release()
+
+	wbs := excel.MustWorkbooks()
+	wb, wbr := wbs.MustAdd()
+	defer wbr()
+
+	ws := wb.MustSheets(1)
+
+	rows := []int{2, 4, 6, 8, 10}
+	for _, row := range rows {
+		ra, _ := ws.Range(row, 5, row, 5)
+
+		err := ra.PageBreak(constants.XlPageBreakManual)
+		if err != nil {
+			t.Error(err)
+		}
+
+		ra.MustSetValue("hello")
+	}
+
+	hpb, _ := ws.HPageBreaks()
+	if count, _ := hpb.Count(); int(count) != len(rows) {
+		t.Errorf("[want] 5\t[got] %v", count)
+	}
+}
+
 func TestXlRange_Count(t *testing.T) {
 	testutil.Interval()
 	defer testutil.Interval()

worksheet.go

@@ -257,6 +257,15 @@ func (ws *Worksheet) VPageBreaks() (*VPageBreaks, error) {
 	return vpbs, nil
 }
 
+func (ws *Worksheet) ResetAllPageBreaks() error {
+	_, err := oleutil.CallMethod(ws.ComObject(), "ResetAllPageBreaks")
+	if err != nil {
+		return err
+	}
+
+	return nil
+}
+
 func (ws *Worksheet) Shapes() (*Shapes, error) {
 	v, err := oleutil.GetProperty(ws.ComObject(), "Shapes")
 	if err != nil {

worksheet_test.go

@@ -10,6 +10,37 @@ import (
 	"github.com/devlights/goxcel/testutil"
 )
 
+func TestWorksheet_ResetAllPageBreaks(t *testing.T) {
+	quit := MustInitGoxcel()
+	defer quit()
+
+	excel, release := MustNewGoxcel()
+	defer release()
+
+	wbs := excel.MustWorkbooks()
+	wb, wbr := wbs.MustAdd()
+	defer wbr()
+
+	ws := wb.MustSheets(1)
+
+	cell := ws.MustCells(10, 5)
+	cell.MustSetValue("hello")
+	_ = cell.PageBreak(constants.XlPageBreakManual)
+
+	vpb, _ := ws.VPageBreaks()
+	if count, _ := vpb.Count(); count != 1 {
+		t.Errorf("[want] 1\t[got] %v", count)
+	}
+
+	if err := ws.ResetAllPageBreaks(); err != nil {
+		t.Error(err)
+	}
+
+	if count, _ := vpb.Count(); count != 0 {
+		t.Errorf("[want] 0\t[got] %v", count)
+	}
+}
+
 func TestWorksheet_UsedRange(t *testing.T) {
 	f := MustInitGoxcel()
 	defer f()