Go-Excelize API源码阅读(十八)——GetPageMargins、SetWorkbookPrOptions
开源摘星计划(WeOpen Star) 是由腾源会 2022 年推出的全新项目,旨在为开源人提供成长激励,为开源项目提供成长支持,助力开发者更好地了解开源,更快地跨越鸿沟,参与到开源的具体贡献与实践中。
不管你是开源萌新,还是希望更深度参与开源贡献的老兵,跟随“开源摘星计划”开启你的开源之旅,从一篇学习笔记、到一段代码的提交,不断挖掘自己的潜能,最终成长为开源社区的“闪亮之星”。
我们将同你一起,探索更多的可能性!
项目地址: WeOpen-Star:https://github.com/weopenprojects/WeOpen-Star
一、Go-Excelize简介
Excelize 是 Go 语言编写的用于操作 Office Excel 文档基础库,基于 ECMA-376,ISO/IEC 29500 国际标准。可以使用它来读取、写入由 Microsoft Excel™ 2007 及以上版本创建的电子表格文档。支持 XLAM / XLSM / XLSX / XLTM / XLTX 等多种文档格式,高度兼容带有样式、图片(表)、透视表、切片器等复杂组件的文档,并提供流式读写 API,用于处理包含大规模数据的工作簿。可应用于各类报表平台、云计算、边缘计算等系统。使用本类库要求使用的 Go 语言为 1.15 或更高版本。
二、 GetPageMargins
func (f *File) GetPageMargins(sheet string, opts ...PageMarginsOptionsPtr) error
直接上源码:
// GetPageMargins provides a function to get worksheet page margins.
//
// Available options:
// PageMarginBottom(float64)
// PageMarginFooter(float64)
// PageMarginHeader(float64)
// PageMarginLeft(float64)
// PageMarginRight(float64)
// PageMarginTop(float64)
func (f *File) GetPageMargins(sheet string, opts ...PageMarginsOptionsPtr) error {
s, err := f.workSheetReader(sheet)
if err != nil {
return err
}
pm := s.PageMargins
for _, opt := range opts {
opt.getPageMargins(pm)
}
return err
}
思路很简单,与前面的几个API都类似,再此不再多说。简单来说,就是读取工作表的PageMargins指针,然后将pm内的值传递到opt指针,然后就能直接通过获取opt的值来获取工作表的页边距。
三、SetWorkbookPrOptions
func (f *File) SetWorkbookPrOptions(opts ...WorkbookPrOption) error
SetWorkbookPrOptions 用于设置工作簿属性。可选参数:
参数 |
数据类型 |
---|---|
Date1904 |
bool |
FilterPrivacy |
bool |
CodeName |
string |
例如,设置工作簿属性:
f := excelize.NewFile()
if err := f.SetWorkbookPrOptions(
excelize.Date1904(false),
excelize.FilterPrivacy(false),
excelize.CodeName("code"),
); err != nil {
fmt.Println(err)
}
先介绍一下这三个参数的含义: Date1904是一个用于WorkbookPrOption的选项,它表明在将工作簿中的序列日期时间转换为日期时,是否使用1900或1904日期系统。
设置和获取工作簿中的 FilterPrivacy 与 CodeName 属性,以解除部分情况下向工作簿中嵌入 VBA 工程时的限制
// SetWorkbookPrOptions provides a function to sets workbook properties.
//
// Available options:
// Date1904(bool)
// FilterPrivacy(bool)
// CodeName(string)
func (f *File) SetWorkbookPrOptions(opts ...WorkbookPrOption) error {
wb := f.workbookReader()
pr := wb.WorkbookPr
if pr == nil {
pr = new(xlsxWorkbookPr)
wb.WorkbookPr = pr
}
for _, opt := range opts {
opt.setWorkbookPrOption(pr)
}
return nil
}
代码也是老样子,这一类API都大同小异,就不说了,不明白的朋友可以去看本源码阅读系列第十六篇的SetPageLayout或第十七篇的SetPageMargins。
四、GetWorkbookPrOptions
本API的代码同前面GetPageMargins API大同小异,就不在此重复解读了,并且参数和SetWorkbookPrOptions的一致。上代码,大家肯定一眼就能看明白。
// GetWorkbookPrOptions provides a function to gets workbook properties.
//
// Available options:
// Date1904(bool)
// FilterPrivacy(bool)
// CodeName(string)
func (f *File) GetWorkbookPrOptions(opts ...WorkbookPrOptionPtr) error {
wb := f.workbookReader()
pr := wb.WorkbookPr
for _, opt := range opts {
opt.getWorkbookPrOption(pr)
}
return nil
}
三、结语
这里是老岳,这是Go语言相关源码的解读第十八篇,我会不断努力,给大家带来更多类似的文章,恳请大家不吝赐教。