169 lines
4.1 KiB
Go
169 lines
4.1 KiB
Go
// Copyright 2016 - 2019 The excelize Authors. All rights reserved. Use of
|
|
// this source code is governed by a BSD-style license that can be found in
|
|
// the LICENSE file.
|
|
//
|
|
// Package excelize providing a set of functions that allow you to write to
|
|
// and read from XLSX files. Support reads and writes XLSX file generated by
|
|
// Microsoft Excel™ 2007 and later. Support save file without losing original
|
|
// charts of XLSX. This library needs Go version 1.8 or later.
|
|
|
|
package excelize
|
|
|
|
// SheetPrOption is an option of a view of a worksheet. See SetSheetPrOptions().
|
|
type SheetPrOption interface {
|
|
setSheetPrOption(view *xlsxSheetPr)
|
|
}
|
|
|
|
// SheetPrOptionPtr is a writable SheetPrOption. See GetSheetPrOptions().
|
|
type SheetPrOptionPtr interface {
|
|
SheetPrOption
|
|
getSheetPrOption(view *xlsxSheetPr)
|
|
}
|
|
|
|
type (
|
|
// CodeName is a SheetPrOption
|
|
CodeName string
|
|
// EnableFormatConditionsCalculation is a SheetPrOption
|
|
EnableFormatConditionsCalculation bool
|
|
// Published is a SheetPrOption
|
|
Published bool
|
|
// FitToPage is a SheetPrOption
|
|
FitToPage bool
|
|
// AutoPageBreaks is a SheetPrOption
|
|
AutoPageBreaks bool
|
|
// OutlineSummaryBelow is an outlinePr, within SheetPr option
|
|
OutlineSummaryBelow bool
|
|
)
|
|
|
|
func (o OutlineSummaryBelow) setSheetPrOption(pr *xlsxSheetPr) {
|
|
if pr.OutlinePr == nil {
|
|
pr.OutlinePr = new(xlsxOutlinePr)
|
|
}
|
|
pr.OutlinePr.SummaryBelow = bool(o)
|
|
}
|
|
|
|
func (o *OutlineSummaryBelow) getSheetPrOption(pr *xlsxSheetPr) {
|
|
// Excel default: true
|
|
if pr == nil || pr.OutlinePr == nil {
|
|
*o = true
|
|
return
|
|
}
|
|
*o = OutlineSummaryBelow(defaultTrue(&pr.OutlinePr.SummaryBelow))
|
|
}
|
|
|
|
func (o CodeName) setSheetPrOption(pr *xlsxSheetPr) {
|
|
pr.CodeName = string(o)
|
|
}
|
|
|
|
func (o *CodeName) getSheetPrOption(pr *xlsxSheetPr) {
|
|
if pr == nil {
|
|
*o = ""
|
|
return
|
|
}
|
|
*o = CodeName(pr.CodeName)
|
|
}
|
|
|
|
func (o EnableFormatConditionsCalculation) setSheetPrOption(pr *xlsxSheetPr) {
|
|
pr.EnableFormatConditionsCalculation = boolPtr(bool(o))
|
|
}
|
|
|
|
func (o *EnableFormatConditionsCalculation) getSheetPrOption(pr *xlsxSheetPr) {
|
|
if pr == nil {
|
|
*o = true
|
|
return
|
|
}
|
|
*o = EnableFormatConditionsCalculation(defaultTrue(pr.EnableFormatConditionsCalculation))
|
|
}
|
|
|
|
func (o Published) setSheetPrOption(pr *xlsxSheetPr) {
|
|
pr.Published = boolPtr(bool(o))
|
|
}
|
|
|
|
func (o *Published) getSheetPrOption(pr *xlsxSheetPr) {
|
|
if pr == nil {
|
|
*o = true
|
|
return
|
|
}
|
|
*o = Published(defaultTrue(pr.Published))
|
|
}
|
|
|
|
func (o FitToPage) setSheetPrOption(pr *xlsxSheetPr) {
|
|
if pr.PageSetUpPr == nil {
|
|
if !o {
|
|
return
|
|
}
|
|
pr.PageSetUpPr = new(xlsxPageSetUpPr)
|
|
}
|
|
pr.PageSetUpPr.FitToPage = bool(o)
|
|
}
|
|
|
|
func (o *FitToPage) getSheetPrOption(pr *xlsxSheetPr) {
|
|
// Excel default: false
|
|
if pr == nil || pr.PageSetUpPr == nil {
|
|
*o = false
|
|
return
|
|
}
|
|
*o = FitToPage(pr.PageSetUpPr.FitToPage)
|
|
}
|
|
|
|
func (o AutoPageBreaks) setSheetPrOption(pr *xlsxSheetPr) {
|
|
if pr.PageSetUpPr == nil {
|
|
if !o {
|
|
return
|
|
}
|
|
pr.PageSetUpPr = new(xlsxPageSetUpPr)
|
|
}
|
|
pr.PageSetUpPr.AutoPageBreaks = bool(o)
|
|
}
|
|
|
|
func (o *AutoPageBreaks) getSheetPrOption(pr *xlsxSheetPr) {
|
|
// Excel default: false
|
|
if pr == nil || pr.PageSetUpPr == nil {
|
|
*o = false
|
|
return
|
|
}
|
|
*o = AutoPageBreaks(pr.PageSetUpPr.AutoPageBreaks)
|
|
}
|
|
|
|
// SetSheetPrOptions provides a function to sets worksheet properties.
|
|
//
|
|
// Available options:
|
|
// CodeName(string)
|
|
// EnableFormatConditionsCalculation(bool)
|
|
// Published(bool)
|
|
// FitToPage(bool)
|
|
// AutoPageBreaks(bool)
|
|
// OutlineSummaryBelow(bool)
|
|
func (f *File) SetSheetPrOptions(name string, opts ...SheetPrOption) error {
|
|
sheet := f.workSheetReader(name)
|
|
pr := sheet.SheetPr
|
|
if pr == nil {
|
|
pr = new(xlsxSheetPr)
|
|
sheet.SheetPr = pr
|
|
}
|
|
|
|
for _, opt := range opts {
|
|
opt.setSheetPrOption(pr)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
// GetSheetPrOptions provides a function to gets worksheet properties.
|
|
//
|
|
// Available options:
|
|
// CodeName(string)
|
|
// EnableFormatConditionsCalculation(bool)
|
|
// Published(bool)
|
|
// FitToPage(bool)
|
|
// AutoPageBreaks(bool)
|
|
// OutlineSummaryBelow(bool)
|
|
func (f *File) GetSheetPrOptions(name string, opts ...SheetPrOptionPtr) error {
|
|
sheet := f.workSheetReader(name)
|
|
pr := sheet.SheetPr
|
|
|
|
for _, opt := range opts {
|
|
opt.getSheetPrOption(pr)
|
|
}
|
|
return nil
|
|
}
|