Go-Excelize API 源码阅读（十八）——GetPageMargins、SetWorkbookPrOptions、GetWorkbookPrOptions

2022 年 8 月 23 日
湖南
本文字数：1573 字
阅读完需：约 5 分钟

Go-Excelize API 源码阅读（十八）——GetPageMargins、SetWorkbookPrOptions

一、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 用于设置工作簿属性。可选参数：

例如，设置工作簿属性:

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}