unioffice/document/hyperlink.go
Gunnsteinn Hall 5335bf249b
License update (#426)
* update license and terms

* Fixes

* Create ACKNOWLEDGEMENTS.md

* Update ACKNOWLEDGEMENTS.md

* Revert go.mod changes and remove go1.11 tests
2020-08-08 01:01:05 +00:00

64 lines
1.8 KiB
Go

// Copyright 2017 FoxyUtils ehf. All rights reserved.
//
// Use of this software package and source code is governed by the terms of the
// UniDoc End User License Agreement (EULA) that is available at:
// https://unidoc.io/eula/
// A trial license code for evaluation can be obtained at https://unidoc.io.
package document
import (
"github.com/unidoc/unioffice"
"github.com/unidoc/unioffice/common"
"github.com/unidoc/unioffice/schema/soo/wml"
)
// HyperLink is a link within a document.
type HyperLink struct {
d *Document
x *wml.CT_Hyperlink
}
// X returns the inner wrapped XML type.
func (h HyperLink) X() *wml.CT_Hyperlink {
return h.x
}
// SetTargetByRef sets the URL target of the hyperlink and is more efficient if a link
// destination will be used many times.
func (h HyperLink) SetTargetByRef(link common.Hyperlink) {
h.x.IdAttr = unioffice.String(common.Relationship(link).ID())
h.x.AnchorAttr = nil
}
// SetTarget sets the URL target of the hyperlink.
func (h HyperLink) SetTarget(url string) {
rel := h.d.AddHyperlink(url)
h.x.IdAttr = unioffice.String(common.Relationship(rel).ID())
h.x.AnchorAttr = nil
}
// SetTargetBookmark sets the bookmark target of the hyperlink.
func (h HyperLink) SetTargetBookmark(bm Bookmark) {
h.x.AnchorAttr = unioffice.String(bm.Name())
h.x.IdAttr = nil
}
// SetToolTip sets the tooltip text for a hyperlink.
func (h HyperLink) SetToolTip(text string) {
if text == "" {
h.x.TooltipAttr = nil
} else {
h.x.TooltipAttr = unioffice.String(text)
}
}
// AddRun adds a run of text to a hyperlink. This is the text that will be linked.
func (h HyperLink) AddRun() Run {
rc := wml.NewEG_ContentRunContent()
h.x.EG_ContentRunContent = append(h.x.EG_ContentRunContent, rc)
r := wml.NewCT_R()
rc.R = r
return Run{h.d, r}
}