前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Go-Excelize API源码阅读(三十九)——SetCellHyperLink

Go-Excelize API源码阅读(三十九)——SetCellHyperLink

作者头像
Regan Yue
发布2022-12-03 08:58:52
5180
发布2022-12-03 08:58:52
举报
文章被收录于专栏:ReganYue's Blog

Go-Excelize API源码阅读(三十九)——SetCellHyperLink

开源摘星计划(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 或更高版本。

二、SetCellHyperLink
代码语言:javascript
复制
func (f *File) SetCellHyperLink(sheet, cell, link, linkType string, opts ...HyperlinkOpts) error

根据给定的工作表、单元格坐标、链接资源和资源类型设置单元格的超链接。资源类型分为外部链接地址 External 和工作簿内部位置链接 Location 两种。每个工作表中的包含最大超链接限制为 65530 个。该方法仅设置单元格的超链接而不影响单元格的值,若需设置单元格的值,请通过 SetCellStyle 或 SetSheetRow 等函数另行设置。

例1,为名为 Sheet1 的工作表 A3 单元格添加外部链接:

代码语言:javascript
复制
display, tooltip := "https://github.com/xuri/excelize", "Excelize on GitHub"
if err := f.SetCellHyperLink("Sheet1", "A3",
    "https://github.com/xuri/excelize", "External", excelize.HyperlinkOpts{
        Display: &display,
        Tooltip: &tooltip,
    }); err != nil {
    fmt.Println(err)
}
// 为单元格设置字体和下划线样式
style, err := f.NewStyle(&excelize.Style{
    Font: &excelize.Font{Color: "#1265BE", Underline: "single"},
})
if err != nil {
    fmt.Println(err)
}
err = f.SetCellStyle("Sheet1", "A3", "A3", style)

例2,为名为 Sheet1 的工作表 A3 单元格添加内部位置链接:

代码语言:javascript
复制
err := f.SetCellHyperLink("Sheet1", "A3", "Sheet1!A40", "Location")

废话少说,直接看代码:

代码语言:javascript
复制
func (f *File) SetCellHyperLink(sheet, cell, link, linkType string, opts ...HyperlinkOpts) error {
	// Check for correct cell name
	if _, _, err := SplitCellName(cell); err != nil {
		return err
	}

	ws, err := f.workSheetReader(sheet)
	if err != nil {
		return err
	}
	if cell, err = f.mergeCellsParser(ws, cell); err != nil {
		return err
	}

	var linkData xlsxHyperlink
	idx := -1
	if ws.Hyperlinks == nil {
		ws.Hyperlinks = new(xlsxHyperlinks)
	}
	for i, hyperlink := range ws.Hyperlinks.Hyperlink {
		if hyperlink.Ref == cell {
			idx = i
			linkData = hyperlink
			break
		}
	}

	if len(ws.Hyperlinks.Hyperlink) > TotalSheetHyperlinks {
		return ErrTotalSheetHyperlinks
	}

	switch linkType {
	case "External":
		sheetPath, _ := f.getSheetXMLPath(sheet)
		sheetRels := "xl/worksheets/_rels/" + strings.TrimPrefix(sheetPath, "xl/worksheets/") + ".rels"
		rID := f.setRels(linkData.RID, sheetRels, SourceRelationshipHyperLink, link, linkType)
		linkData = xlsxHyperlink{
			Ref: cell,
		}
		linkData.RID = "rId" + strconv.Itoa(rID)
		f.addSheetNameSpace(sheet, SourceRelationship)
	case "Location":
		linkData = xlsxHyperlink{
			Ref:      cell,
			Location: link,
		}
	default:
		return fmt.Errorf("invalid link type %q", linkType)
	}

	for _, o := range opts {
		if o.Display != nil {
			linkData.Display = *o.Display
		}
		if o.Tooltip != nil {
			linkData.Tooltip = *o.Tooltip
		}
	}
	if idx == -1 {
		ws.Hyperlinks.Hyperlink = append(ws.Hyperlinks.Hyperlink, linkData)
		return err
	}
	ws.Hyperlinks.Hyperlink[idx] = linkData
	return err
}
在这里插入图片描述
在这里插入图片描述

这段代码是用来检测单元格名称是否正确。

mergeCellsParser通过给定的单元格引用来解析工作表中的合并单元格。

在这里插入图片描述
在这里插入图片描述

建立一个xlsxHyperlink对象,将索引idx设置为-1,如果工作表对象ws的Hyperlinks超链接字段为nil,就new一个xlsxHyperlinks。

在这里插入图片描述
在这里插入图片描述

然后遍历ws.Hyperlinks.Hyperlink超链接对象,如果超链接的Ref字段为我们的参数cell,即放置超链接的单元格。 我们就将超链接在xlsxHyperlink切片内的超链接和索引都保存。

每个工作表中的包含最大超链接限制为 65530 个。如果超过了就返回ErrTotalSheetHyperlinks错误。

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

如果linkType为"External",说明是外部链接,我们就将外部链接保存即可。

如果linkType为"Location",说明是内部链接,我们将cell和link保存至linkData即可。

在这里插入图片描述
在这里插入图片描述

遍历超链接属性opts,如果其Display属性和Tooltip属性不为nil,我们就将他们给linkData。

在这里插入图片描述
在这里插入图片描述

如果到此idx还为-1,说明下面这段代码没有达成:

代码语言:javascript
复制
	for i, hyperlink := range ws.Hyperlinks.Hyperlink {
		if hyperlink.Ref == cell {
			idx = i
			linkData = hyperlink
			break
		}
	}

最后将linkData放入ws.Hyperlinks.Hyperlink切片之中。

结语

这是Excelize API阅读的第三十九篇,鉴于本人技术水平有限,如有错误,烦请指出斧正!感谢!

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
原始发表:2022/12/02 ,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • Go-Excelize API源码阅读(三十九)——SetCellHyperLink
    • 一、Go-Excelize简介
      • 二、SetCellHyperLink
        • 结语
        相关产品与服务
        边缘可用区
        腾讯云边缘可用区(TencentCloud Edge Zone,TEZ)是腾讯云的本地扩展,适用于解决计算、存储和服务可用性问题。腾讯云边缘可用区可为您带来云的诸多优势,例如弹性、可扩展性和安全性。借助腾讯云边缘可用区,您可以在靠近最终用户的地理位置运行对延迟敏感的应用程序,基本消除延迟问题。腾讯云边缘可用区提供与中心节点一致的体验,助力业务下沉,具备更低延时、更广覆盖、更少成本等特点。
        领券
        问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档