HomeUniDoc
HomeUniDoc
...

Package document

Overview ▾

Package document provides creation, reading, and writing of ECMA 376 Open Office XML documents.

Example:

doc := document.New()
para := doc.AddParagraph()
run := para.AddRun()
run.SetText("foo")
doc.SaveToFile("foo.docx")

Index ▾

Constants
type AnchoredDrawing
    func (a AnchoredDrawing) GetImage() (common.ImageRef, bool)
    func (a AnchoredDrawing) SetAlignment(h wml.WdST_AlignH, v wml.WdST_AlignV)
    func (a AnchoredDrawing) SetHAlignment(h wml.WdST_AlignH)
    func (a AnchoredDrawing) SetName(name string)
    func (a AnchoredDrawing) SetOffset(x, y measurement.Distance)
    func (a AnchoredDrawing) SetOrigin(h wml.WdST_RelFromH, v wml.WdST_RelFromV)
    func (a AnchoredDrawing) SetSize(w, h measurement.Distance)
    func (a AnchoredDrawing) SetTextWrapNone()
    func (a AnchoredDrawing) SetTextWrapSquare(t wml.WdST_WrapText)
    func (a AnchoredDrawing) SetVAlignment(v wml.WdST_AlignV)
    func (a AnchoredDrawing) SetXOffset(x measurement.Distance)
    func (a AnchoredDrawing) SetYOffset(y measurement.Distance)
    func (a AnchoredDrawing) X() *wml.WdAnchor
type Bookmark
    func (b Bookmark) Name() string
    func (b Bookmark) SetName(name string)
    func (b Bookmark) X() *wml.CT_Bookmark
type Cell
    func (c Cell) AddParagraph() Paragraph
    func (c Cell) AddTable() Table
    func (c Cell) Paragraphs() []Paragraph
    func (c Cell) Properties() CellProperties
    func (c Cell) X() *wml.CT_Tc
type CellBorders
    func (b CellBorders) SetAll(t wml.ST_Border, c color.Color, thickness measurement.Distance)
    func (b CellBorders) SetBottom(t wml.ST_Border, c color.Color, thickness measurement.Distance)
    func (b CellBorders) SetInsideHorizontal(t wml.ST_Border, c color.Color, thickness measurement.Distance)
    func (b CellBorders) SetInsideVertical(t wml.ST_Border, c color.Color, thickness measurement.Distance)
    func (b CellBorders) SetLeft(t wml.ST_Border, c color.Color, thickness measurement.Distance)
    func (b CellBorders) SetRight(t wml.ST_Border, c color.Color, thickness measurement.Distance)
    func (b CellBorders) SetTop(t wml.ST_Border, c color.Color, thickness measurement.Distance)
    func (b CellBorders) X() *wml.CT_TcBorders
type CellMargins
    func (c CellMargins) SetBottom(d measurement.Distance)
    func (c CellMargins) SetBottomPct(pct float64)
    func (c CellMargins) SetLeft(d measurement.Distance)
    func (c CellMargins) SetLeftPct(pct float64)
    func (c CellMargins) SetRight(d measurement.Distance)
    func (c CellMargins) SetRightPct(pct float64)
    func (c CellMargins) SetStart(d measurement.Distance)
    func (c CellMargins) SetStartPct(pct float64)
    func (c CellMargins) SetTop(d measurement.Distance)
    func (c CellMargins) SetTopPct(pct float64)
type CellProperties
    func (c CellProperties) Borders() CellBorders
    func (c CellProperties) Margins() CellMargins
    func (c CellProperties) SetColumnSpan(cols int)
    func (c CellProperties) SetShading(shd wml.ST_Shd, foreground, fill color.Color)
    func (c CellProperties) SetVerticalAlignment(align wml.ST_VerticalJc)
    func (c CellProperties) SetVerticalMerge(mergeVal wml.ST_Merge)
    func (c CellProperties) SetWidth(d measurement.Distance)
    func (c CellProperties) SetWidthAuto()
    func (c CellProperties) SetWidthPercent(pct float64)
    func (c CellProperties) X() *wml.CT_TcPr
type Color
    func (c Color) SetColor(v color.Color)
    func (c Color) SetThemeColor(t wml.ST_ThemeColor)
    func (c Color) SetThemeShade(s uint8)
    func (c Color) X() *wml.CT_Color
type DocText
    func (d *DocText) Text() string
type Document
    func New() *Document
    func Open(filename string) (*Document, error)
    func OpenTemplate(filename string) (*Document, error)
    func Read(r io.ReaderAt, size int64) (*Document, error)
    func (d *Document) AddFooter() Footer
    func (d *Document) AddHeader() Header
    func (d Document) AddHyperlink(url string) common.Hyperlink
    func (d *Document) AddImage(i common.Image) (common.ImageRef, error)
    func (d *Document) AddParagraph() Paragraph
    func (d *Document) AddTable() Table
    func (d0 *Document) Append(d1orig *Document) error
    func (d *Document) BodySection() Section
    func (d Document) Bookmarks() []Bookmark
    func (d *Document) Close() error
    func (d *Document) Copy() (*Document, error)
    func (d *Document) Endnote(id int64) Endnote
    func (d *Document) Endnotes() []Endnote
    func (d *Document) ExtractText() *DocText
    func (d *Document) Footers() []Footer
    func (d *Document) Footnote(id int64) Footnote
    func (d *Document) Footnotes() []Footnote
    func (d *Document) FormFields() []FormField
    func (d *Document) GetDocRelTargetByID(idAttr string) string
    func (d *Document) GetImageByRelID(relID string) (common.ImageRef, bool)
    func (d *Document) GetImageObjByRelId(relId string) (common.Image, error)
    func (d *Document) GetStyleByID(id string) Style
    func (d *Document) GetTargetByRelId(idAttr string) string
    func (d *Document) HasEndnotes() bool
    func (d *Document) HasFootnotes() bool
    func (d *Document) Headers() []Header
    func (d *Document) InsertParagraphAfter(relativeTo Paragraph) Paragraph
    func (d *Document) InsertParagraphBefore(relativeTo Paragraph) Paragraph
    func (d *Document) InsertTableAfter(relativeTo Paragraph) Table
    func (d *Document) InsertTableBefore(relativeTo Paragraph) Table
    func (d *Document) MailMerge(mergeContent map[string]string)
    func (d Document) MergeFields() []string
    func (d *Document) Paragraphs() []Paragraph
    func (d *Document) RemoveParagraph(p Paragraph)
    func (d *Document) Save(w io.Writer) error
    func (d *Document) SaveToFile(path string) error
    func (d Document) SetConformance(conformanceAttr st.ST_ConformanceClass)
    func (d Document) SetStrict(strict bool)
    func (d *Document) StructuredDocumentTags() []StructuredDocumentTag
    func (d *Document) Tables() []Table
    func (d *Document) Validate() error
    func (d *Document) X() *wml.Document
type DrawingInfo
type Endnote
    func (e Endnote) AddParagraph() Paragraph
    func (e Endnote) Paragraphs() []Paragraph
    func (e Endnote) RemoveParagraph(p Paragraph)
    func (e Endnote) X() *wml.CT_FtnEdn
type Fonts
    func (f Fonts) SetASCIITheme(t wml.ST_Theme)
    func (f Fonts) SetCSTheme(t wml.ST_Theme)
    func (f Fonts) SetEastAsiaTheme(t wml.ST_Theme)
    func (f Fonts) SetHANSITheme(t wml.ST_Theme)
    func (f Fonts) X() *wml.CT_Fonts
type Footer
    func (f Footer) AddImage(i common.Image) (common.ImageRef, error)
    func (f Footer) AddParagraph() Paragraph
    func (f Footer) Clear()
    func (f Footer) Index() int
    func (f Footer) Paragraphs() []Paragraph
    func (f Footer) RemoveParagraph(p Paragraph)
    func (f Footer) Tables() []Table
    func (f Footer) X() *wml.Ftr
type Footnote
    func (f Footnote) AddParagraph() Paragraph
    func (f Footnote) Paragraphs() []Paragraph
    func (f Footnote) RemoveParagraph(p Paragraph)
    func (f Footnote) X() *wml.CT_FtnEdn
type FormField
    func (f FormField) IsChecked() bool
    func (f FormField) Name() string
    func (f FormField) PossibleValues() []string
    func (f FormField) SetCalcOnExit(calcOnExit bool)
    func (f FormField) SetChecked(b bool)
    func (f FormField) SetDefaultValue(v string)
    func (f FormField) SetEnabled(enabled bool)
    func (f FormField) SetName(name string)
    func (f FormField) SetPossibleValues(values []string)
    func (f FormField) SetSize(size uint64)
    func (f FormField) SetValue(v string)
    func (f FormField) Type() FormFieldType
    func (f FormField) Value() string
type FormFieldType
    func (i FormFieldType) String() string
type Header
    func (h Header) AddImage(i common.Image) (common.ImageRef, error)
    func (h Header) AddParagraph() Paragraph
    func (h Header) Clear()
    func (h Header) Index() int
    func (h Header) Paragraphs() []Paragraph
    func (h Header) RemoveParagraph(p Paragraph)
    func (h Header) Tables() []Table
    func (h Header) X() *wml.Hdr
type HyperLink
    func (h HyperLink) AddRun() Run
    func (h HyperLink) SetTarget(url string)
    func (h HyperLink) SetTargetBookmark(bm Bookmark)
    func (h HyperLink) SetTargetByRef(link common.Hyperlink)
    func (h HyperLink) SetToolTip(text string)
    func (h HyperLink) X() *wml.CT_Hyperlink
type InlineDrawing
    func (i InlineDrawing) GetImage() (common.ImageRef, bool)
    func (i InlineDrawing) SetSize(w, h measurement.Distance)
    func (i InlineDrawing) X() *wml.WdInline
type Numbering
    func NewNumbering() Numbering
    func (n Numbering) AddDefinition() NumberingDefinition
    func (n Numbering) Clear()
    func (n Numbering) Definitions() []NumberingDefinition
    func (n Numbering) InitializeDefault()
    func (n Numbering) X() *wml.Numbering
type NumberingDefinition
    func (n NumberingDefinition) AbstractNumberID() int64
    func (n NumberingDefinition) AddLevel() NumberingLevel
    func (n NumberingDefinition) Levels() []NumberingLevel
    func (n NumberingDefinition) MultiLevelType() wml.ST_MultiLevelType
    func (n NumberingDefinition) SetMultiLevelType(t wml.ST_MultiLevelType)
    func (n NumberingDefinition) X() *wml.CT_AbstractNum
type NumberingLevel
    func (n NumberingLevel) Properties() ParagraphStyleProperties
    func (n NumberingLevel) RunProperties() RunProperties
    func (n NumberingLevel) SetAlignment(j wml.ST_Jc)
    func (n NumberingLevel) SetFormat(f wml.ST_NumberFormat)
    func (n NumberingLevel) SetText(t string)
    func (n NumberingLevel) X() *wml.CT_Lvl
type OnOffValue
type Paragraph
    func (p Paragraph) AddBookmark(name string) Bookmark
    func (p Paragraph) AddCheckBox(name string) FormField
    func (p Paragraph) AddDropdownList(name string) FormField
    func (p Paragraph) AddEndnote(text string) Endnote
    func (p Paragraph) AddFootnote(text string) Footnote
    func (p Paragraph) AddHyperLink() HyperLink
    func (p Paragraph) AddRun() Run
    func (p Paragraph) AddTextInput(name string) FormField
    func (p Paragraph) InsertRunAfter(relativeTo Run) Run
    func (p Paragraph) InsertRunBefore(relativeTo Run) Run
    func (p Paragraph) Properties() ParagraphProperties
    func (p Paragraph) RemoveEndnote(id int64)
    func (p Paragraph) RemoveFootnote(id int64)
    func (p Paragraph) RemoveRun(r Run)
    func (p Paragraph) Runs() []Run
    func (p Paragraph) SetFirstLineIndent(m measurement.Distance)
    func (p Paragraph) SetLineSpacing(d measurement.Distance, rule wml.ST_LineSpacingRule)
    func (p Paragraph) SetNumberingDefinition(nd NumberingDefinition)
    func (p Paragraph) SetNumberingDefinitionByID(abstractNumberID int64)
    func (p Paragraph) SetNumberingLevel(listLevel int)
    func (p Paragraph) SetStyle(s string)
    func (p Paragraph) Style() string
    func (p Paragraph) X() *wml.CT_P
type ParagraphProperties
    func (p ParagraphProperties) AddSection(t wml.ST_SectionMark) Section
    func (p ParagraphProperties) AddTabStop(position measurement.Distance, justificaton wml.ST_TabJc, leader wml.ST_TabTlc)
    func (p ParagraphProperties) Bold() bool
    func (p ParagraphProperties) Caps() bool
    func (p ParagraphProperties) CharacterSpacingMeasure() string
    func (p ParagraphProperties) CharacterSpacingValue() int64
    func (p ParagraphProperties) ComplexSizeMeasure() string
    func (p ParagraphProperties) ComplexSizeValue() float64
    func (p ParagraphProperties) DoubleStrike() bool
    func (p ParagraphProperties) EastAsiaFont() string
    func (p ParagraphProperties) Emboss() bool
    func (p ParagraphProperties) Font() string
    func (p ParagraphProperties) GetColor() color.Color
    func (p ParagraphProperties) Italic() bool
    func (p ParagraphProperties) Outline() bool
    func (p ParagraphProperties) RStyle() string
    func (p ParagraphProperties) RightToLeft() bool
    func (p ParagraphProperties) SetAlignment(align wml.ST_Jc)
    func (p ParagraphProperties) SetEndIndent(m measurement.Distance)
    func (p ParagraphProperties) SetFirstLineIndent(m measurement.Distance)
    func (p ParagraphProperties) SetHangingIndent(m measurement.Distance)
    func (p ParagraphProperties) SetHeadingLevel(idx int)
    func (p ParagraphProperties) SetKeepOnOnePage(b bool)
    func (p ParagraphProperties) SetKeepWithNext(b bool)
    func (p ParagraphProperties) SetPageBreakBefore(b bool)
    func (p ParagraphProperties) SetSpacing(before, after measurement.Distance)
    func (p ParagraphProperties) SetStartIndent(m measurement.Distance)
    func (p ParagraphProperties) SetStyle(s string)
    func (p ParagraphProperties) SetWindowControl(b bool)
    func (p ParagraphProperties) Shadow() bool
    func (p ParagraphProperties) SizeMeasure() string
    func (p ParagraphProperties) SizeValue() float64
    func (p ParagraphProperties) Spacing() ParagraphSpacing
    func (p ParagraphProperties) Strike() bool
    func (p ParagraphProperties) Style() string
    func (p ParagraphProperties) Underline() wml.ST_Underline
    func (p ParagraphProperties) UnderlineColor() string
    func (p ParagraphProperties) VerticalAlignment() sharedTypes.ST_VerticalAlignRun
    func (p ParagraphProperties) X() *wml.CT_PPr
type ParagraphSpacing
    func (p ParagraphSpacing) SetAfter(after measurement.Distance)
    func (p ParagraphSpacing) SetAfterAuto(b bool)
    func (p ParagraphSpacing) SetBefore(before measurement.Distance)
    func (p ParagraphSpacing) SetBeforeAuto(b bool)
    func (p ParagraphSpacing) SetLineSpacing(d measurement.Distance, rule wml.ST_LineSpacingRule)
type ParagraphStyleProperties
    func (p ParagraphStyleProperties) AddTabStop(position measurement.Distance, justificaton wml.ST_TabJc, leader wml.ST_TabTlc)
    func (p ParagraphStyleProperties) SetAlignment(align wml.ST_Jc)
    func (p ParagraphStyleProperties) SetContextualSpacing(b bool)
    func (p ParagraphStyleProperties) SetHangingIndent(m measurement.Distance)
    func (p ParagraphStyleProperties) SetKeepNext(b bool)
    func (p ParagraphStyleProperties) SetKeepOnOnePage(b bool)
    func (p ParagraphStyleProperties) SetLeftIndent(m measurement.Distance)
    func (p ParagraphStyleProperties) SetOutlineLevel(lvl int)
    func (p ParagraphStyleProperties) SetSpacing(before, after measurement.Distance)
    func (p ParagraphStyleProperties) SetStartIndent(m measurement.Distance)
    func (p ParagraphStyleProperties) X() *wml.CT_PPrGeneral
type Row
    func (r Row) AddCell() Cell
    func (r Row) Cells() []Cell
    func (r Row) Properties() RowProperties
    func (r Row) X() *wml.CT_Row
type RowProperties
    func (r RowProperties) SetHeight(ht measurement.Distance, rule wml.ST_HeightRule)
type Run
    func (r Run) AddBreak()
    func (r Run) AddDrawingAnchored(img common.ImageRef) (AnchoredDrawing, error)
    func (r Run) AddDrawingInline(img common.ImageRef) (InlineDrawing, error)
    func (r Run) AddField(code string)
    func (r Run) AddFieldWithFormatting(code string, fmt string, isDirty bool)
    func (r Run) AddPageBreak()
    func (r Run) AddTab()
    func (r Run) AddText(s string)
    func (r Run) Clear()
    func (r Run) ClearContent()
    func (r Run) DrawingAnchored() []AnchoredDrawing
    func (r Run) IsEndnote() (bool, int64)
    func (r Run) IsFootnote() (bool, int64)
    func (r Run) Properties() RunProperties
    func (r Run) Text() string
    func (r Run) X() *wml.CT_R
type RunProperties
    func (r RunProperties) Bold() bool
    func (r RunProperties) BoldValue() OnOffValue
    func (r RunProperties) Caps() bool
    func (r RunProperties) CharacterSpacingMeasure() string
    func (r RunProperties) CharacterSpacingValue() int64
    func (r RunProperties) ClearColor()
    func (r RunProperties) Color() Color
    func (r RunProperties) ComplexSizeMeasure() string
    func (r RunProperties) ComplexSizeValue() float64
    func (r RunProperties) DoubleStrike() bool
    func (r RunProperties) EastAsiaFont() string
    func (r RunProperties) Emboss() bool
    func (r RunProperties) Font() string
    func (r RunProperties) Fonts() Fonts
    func (r RunProperties) GetColor() color.Color
    func (r RunProperties) IsBold() bool
    func (r RunProperties) IsItalic() bool
    func (r RunProperties) Italic() bool
    func (r RunProperties) ItalicValue() OnOffValue
    func (r RunProperties) Outline() bool
    func (r RunProperties) RStyle() string
    func (r RunProperties) RightToLeft() bool
    func (r RunProperties) SetAllCaps(b bool)
    func (r RunProperties) SetBold(b bool)
    func (r RunProperties) SetCharacterSpacing(size measurement.Distance)
    func (r RunProperties) SetColor(c color.Color)
    func (r RunProperties) SetDoubleStrikeThrough(b bool)
    func (r RunProperties) SetEffect(e wml.ST_TextEffect)
    func (r RunProperties) SetEmboss(b bool)
    func (r RunProperties) SetFontFamily(family string)
    func (r RunProperties) SetHighlight(c wml.ST_HighlightColor)
    func (r RunProperties) SetImprint(b bool)
    func (r RunProperties) SetItalic(b bool)
    func (r RunProperties) SetKerning(size measurement.Distance)
    func (r RunProperties) SetOutline(b bool)
    func (r RunProperties) SetShadow(b bool)
    func (r RunProperties) SetSize(size measurement.Distance)
    func (r RunProperties) SetSmallCaps(b bool)
    func (r RunProperties) SetStrikeThrough(b bool)
    func (r RunProperties) SetStyle(style string)
    func (r RunProperties) SetUnderline(style wml.ST_Underline, c color.Color)
    func (r RunProperties) SetVerticalAlignment(v sharedTypes.ST_VerticalAlignRun)
    func (r RunProperties) Shadow() bool
    func (r RunProperties) SizeMeasure() string
    func (r RunProperties) SizeValue() float64
    func (r RunProperties) Strike() bool
    func (r RunProperties) Underline() wml.ST_Underline
    func (r RunProperties) UnderlineColor() string
    func (r RunProperties) VerticalAlignment() sharedTypes.ST_VerticalAlignRun
    func (r RunProperties) X() *wml.CT_RPr
type Section
    func (s Section) GetFooter(t wml.ST_HdrFtr) (Footer, bool)
    func (s Section) GetHeader(t wml.ST_HdrFtr) (Header, bool)
    func (s Section) SetFooter(f Footer, t wml.ST_HdrFtr)
    func (s Section) SetHeader(h Header, t wml.ST_HdrFtr)
    func (s Section) SetPageMargins(top, right, bottom, left, header, footer, gutter measurement.Distance)
    func (s Section) X() *wml.CT_SectPr
type Settings
    func NewSettings() Settings
    func (s Settings) RemoveMailMerge()
    func (s Settings) SetUpdateFieldsOnOpen(b bool)
    func (s Settings) X() *wml.Settings
type StructuredDocumentTag
    func (s StructuredDocumentTag) Paragraphs() []Paragraph
type Style
    func (s Style) Name() string
    func (s Style) ParagraphProperties() ParagraphStyleProperties
    func (s Style) RunProperties() RunProperties
    func (s Style) SetBasedOn(name string)
    func (s Style) SetLinkedStyle(name string)
    func (s Style) SetName(name string)
    func (s Style) SetNextStyle(name string)
    func (s Style) SetPrimaryStyle(b bool)
    func (s Style) SetSemiHidden(b bool)
    func (s Style) SetUISortOrder(order int)
    func (s Style) SetUnhideWhenUsed(b bool)
    func (s Style) StyleID() string
    func (s Style) TableConditionalFormatting(typ wml.ST_TblStyleOverrideType) TableConditionalFormatting
    func (s Style) TableProperties() TableStyleProperties
    func (s Style) Type() wml.ST_StyleType
    func (s Style) X() *wml.CT_Style
type Styles
    func NewStyles() Styles
    func (s Styles) AddStyle(styleID string, t wml.ST_StyleType, isDefault bool) Style
    func (s Styles) Clear()
    func (s Styles) InitializeDefault()
    func (s Styles) ParagraphStyles() []Style
    func (s Styles) Styles() []Style
    func (s Styles) X() *wml.Styles
type Table
    func (t Table) AddRow() Row
    func (t Table) InsertRowAfter(r Row) Row
    func (t Table) InsertRowBefore(r Row) Row
    func (t Table) Properties() TableProperties
    func (t Table) Rows() []Row
    func (t Table) X() *wml.CT_Tbl
type TableBorders
    func (b TableBorders) SetAll(t wml.ST_Border, c color.Color, thickness measurement.Distance)
    func (b TableBorders) SetBottom(t wml.ST_Border, c color.Color, thickness measurement.Distance)
    func (b TableBorders) SetInsideHorizontal(t wml.ST_Border, c color.Color, thickness measurement.Distance)
    func (b TableBorders) SetInsideVertical(t wml.ST_Border, c color.Color, thickness measurement.Distance)
    func (b TableBorders) SetLeft(t wml.ST_Border, c color.Color, thickness measurement.Distance)
    func (b TableBorders) SetRight(t wml.ST_Border, c color.Color, thickness measurement.Distance)
    func (b TableBorders) SetTop(t wml.ST_Border, c color.Color, thickness measurement.Distance)
    func (b TableBorders) X() *wml.CT_TblBorders
type TableConditionalFormatting
    func (t TableConditionalFormatting) CellProperties() CellProperties
    func (t TableConditionalFormatting) ParagraphProperties() ParagraphStyleProperties
    func (t TableConditionalFormatting) RunProperties() RunProperties
    func (t TableConditionalFormatting) X() *wml.CT_TblStylePr
type TableInfo
type TableLook
    func (t TableLook) SetFirstColumn(on bool)
    func (t TableLook) SetFirstRow(on bool)
    func (t TableLook) SetHorizontalBanding(on bool)
    func (t TableLook) SetLastColumn(on bool)
    func (t TableLook) SetLastRow(on bool)
    func (t TableLook) SetVerticalBanding(on bool)
    func (t TableLook) X() *wml.CT_TblLook
type TableProperties
    func (t TableProperties) Borders() TableBorders
    func (t TableProperties) SetAlignment(align wml.ST_JcTable)
    func (t TableProperties) SetCellSpacing(m measurement.Distance)
    func (t TableProperties) SetCellSpacingAuto()
    func (t TableProperties) SetCellSpacingPercent(pct float64)
    func (t TableProperties) SetLayout(l wml.ST_TblLayoutType)
    func (t TableProperties) SetStyle(name string)
    func (t TableProperties) SetWidth(d measurement.Distance)
    func (t TableProperties) SetWidthAuto()
    func (t TableProperties) SetWidthPercent(pct float64)
    func (t TableProperties) TableLook() TableLook
    func (t TableProperties) X() *wml.CT_TblPr
type TableStyleProperties
    func (t TableStyleProperties) Borders() TableBorders
    func (t TableStyleProperties) SetCellSpacingAuto()
    func (t TableStyleProperties) SetCellSpacingPercent(pct float64)
    func (t TableStyleProperties) SetColumnBandSize(cols int64)
    func (t TableStyleProperties) SetRowBandSize(rows int64)
    func (t TableStyleProperties) SetTableIndent(ind measurement.Distance)
    func (t TableStyleProperties) X() *wml.CT_TblPrBase
type TableWidth
    func NewTableWidth() TableWidth
    func (s TableWidth) SetValue(m measurement.Distance)
    func (s TableWidth) X() *wml.CT_TblWidth
type TextItem
    func ExtractFromFooter(footer *wml.Ftr) []TextItem
    func ExtractFromHeader(header *wml.Hdr) []TextItem

Examples

Document.FormFields
New
Open
OpenTemplate

Package files

anchoreddrawing.go bookmark.go cell.go cellborders.go cellmargins.go cellproperties.go color.go doc.go document.go endnotes.go extract.go fonts.go footer.go footnotes.go formfield.go formfieldtype_string.go header.go hyperlink.go inlinedrawing.go knownfields.go mailmerge.go numbering.go numberingdefinition.go numberinglevel.go onoffvalue.go paragraph.go paragraphproperties.go paragraphspacing.go paragraphstyleproperties.go row.go rowproperties.go run.go runproperties.go section.go settings.go structuredocumenttag.go style.go styles.go table.go tableborders.go tableconditionalformatting.go tableproperties.go tablestyleproperties.go tablewidth.go tbllook.go

Constants

Field constants

const (
    FieldCurrentPage   = "PAGE"
    FieldNumberOfPages = "NUMPAGES"
    FieldDate          = "DATE"
    FieldCreateDate    = "CREATEDATE"
    FieldEditTime      = "EDITTIME"
    FieldPrintDate     = "PRINTDATE"
    FieldSaveDate      = "SAVEDATE"
    FieldTIme          = "TIME"
    FieldTOC           = "TOC"
)

type AnchoredDrawing

AnchoredDrawing is an absolutely positioned image within a document page.

type AnchoredDrawing struct {
    // contains filtered or unexported fields
}

func (AnchoredDrawing) GetImage

func (a AnchoredDrawing) GetImage() (common.ImageRef, bool)

GetImage returns the ImageRef associated with an AnchoredDrawing.

func (AnchoredDrawing) SetAlignment

func (a AnchoredDrawing) SetAlignment(h wml.WdST_AlignH, v wml.WdST_AlignV)

SetAlignment positions an anchored image via alignment. Offset is incompatible with SetOffset, whichever is called last is applied.

func (AnchoredDrawing) SetHAlignment

func (a AnchoredDrawing) SetHAlignment(h wml.WdST_AlignH)

SetHAlignment sets the horizontal alignment for an anchored image.

func (AnchoredDrawing) SetName

func (a AnchoredDrawing) SetName(name string)

SetName sets the name of the image, visible in the properties of the image within Word.

func (AnchoredDrawing) SetOffset

func (a AnchoredDrawing) SetOffset(x, y measurement.Distance)

SetOffset sets the offset of the image relative to the origin, which by default this is the top-left corner of the page. Offset is incompatible with SetAlignment, whichever is called last is applied.

func (AnchoredDrawing) SetOrigin

func (a AnchoredDrawing) SetOrigin(h wml.WdST_RelFromH, v wml.WdST_RelFromV)

SetOrigin sets the origin of the image. It defaults to ST_RelFromHPage and ST_RelFromVPage

func (AnchoredDrawing) SetSize

func (a AnchoredDrawing) SetSize(w, h measurement.Distance)

SetSize sets the size of the displayed image on the page.

func (AnchoredDrawing) SetTextWrapNone

func (a AnchoredDrawing) SetTextWrapNone()

SetTextWrapNone unsets text wrapping so the image can float on top of the text. When used in conjunction with X/Y Offset relative to the page it can be used to place a logo at the top of a page at an absolute position that doesn't interfere with text.

func (AnchoredDrawing) SetTextWrapSquare

func (a AnchoredDrawing) SetTextWrapSquare(t wml.WdST_WrapText)

SetTextWrapSquare sets the text wrap to square with a given wrap type.

func (AnchoredDrawing) SetVAlignment

func (a AnchoredDrawing) SetVAlignment(v wml.WdST_AlignV)

SetVAlignment sets the vertical alignment for an anchored image.

func (AnchoredDrawing) SetXOffset

func (a AnchoredDrawing) SetXOffset(x measurement.Distance)

SetXOffset sets the X offset for an image relative to the origin.

func (AnchoredDrawing) SetYOffset

func (a AnchoredDrawing) SetYOffset(y measurement.Distance)

SetYOffset sets the Y offset for an image relative to the origin.

func (AnchoredDrawing) X

func (a AnchoredDrawing) X() *wml.WdAnchor

X returns the inner wrapped XML type.

type Bookmark

Bookmark is a bookmarked location within a document that can be referenced with a hyperlink.

type Bookmark struct {
    // contains filtered or unexported fields
}

func (Bookmark) Name

func (b Bookmark) Name() string

Name returns the name of the bookmark whcih is the document unique ID that identifies the bookmark.

func (Bookmark) SetName

func (b Bookmark) SetName(name string)

SetName sets the name of the bookmark. This is the name that is used to reference the bookmark from hyperlinks.

func (Bookmark) X

func (b Bookmark) X() *wml.CT_Bookmark

X returns the inner wrapped XML type.

type Cell

Cell is a table cell within a document (not a spreadsheet)

type Cell struct {
    // contains filtered or unexported fields
}

func (Cell) AddParagraph

func (c Cell) AddParagraph() Paragraph

AddParagraph adds a paragraph to the table cell.

func (Cell) AddTable

func (c Cell) AddTable() Table

AddTable adds a table to the table cell.

func (Cell) Paragraphs

func (c Cell) Paragraphs() []Paragraph

Paragraphs returns the paragraphs defined in the cell.

func (Cell) Properties

func (c Cell) Properties() CellProperties

Properties returns the cell properties.

func (Cell) X

func (c Cell) X() *wml.CT_Tc

X returns the inner wrapped XML type.

type CellBorders

CellBorders are the borders for an individual

type CellBorders struct {
    // contains filtered or unexported fields
}

func (CellBorders) SetAll

func (b CellBorders) SetAll(t wml.ST_Border, c color.Color, thickness measurement.Distance)

SetAll sets all of the borders to a given value.

func (CellBorders) SetBottom

func (b CellBorders) SetBottom(t wml.ST_Border, c color.Color, thickness measurement.Distance)

SetBottom sets the bottom border to a specified type, color and thickness.

func (CellBorders) SetInsideHorizontal

func (b CellBorders) SetInsideHorizontal(t wml.ST_Border, c color.Color, thickness measurement.Distance)

SetInsideHorizontal sets the interior horizontal borders to a specified type, color and thickness.

func (CellBorders) SetInsideVertical

func (b CellBorders) SetInsideVertical(t wml.ST_Border, c color.Color, thickness measurement.Distance)

SetInsideVertical sets the interior vertical borders to a specified type, color and thickness.

func (CellBorders) SetLeft

func (b CellBorders) SetLeft(t wml.ST_Border, c color.Color, thickness measurement.Distance)

SetLeft sets the left border to a specified type, color and thickness.

func (CellBorders) SetRight

func (b CellBorders) SetRight(t wml.ST_Border, c color.Color, thickness measurement.Distance)

SetRight sets the right border to a specified type, color and thickness.

func (CellBorders) SetTop

func (b CellBorders) SetTop(t wml.ST_Border, c color.Color, thickness measurement.Distance)

SetTop sets the top border to a specified type, color and thickness.

func (CellBorders) X

func (b CellBorders) X() *wml.CT_TcBorders

X returns the inner wrapped type

type CellMargins

CellMargins are the margins for an individual cell.

type CellMargins struct {
    // contains filtered or unexported fields
}

func (CellMargins) SetBottom

func (c CellMargins) SetBottom(d measurement.Distance)

SetBottom sets the cell bottom margin

func (CellMargins) SetBottomPct

func (c CellMargins) SetBottomPct(pct float64)

SetBottomPct sets the cell bottom margin

func (CellMargins) SetLeft

func (c CellMargins) SetLeft(d measurement.Distance)

SetLeft sets the cell left margin

func (CellMargins) SetLeftPct

func (c CellMargins) SetLeftPct(pct float64)

SetLeftPct sets the cell left margin

func (CellMargins) SetRight

func (c CellMargins) SetRight(d measurement.Distance)

SetRight sets the cell right margin

func (CellMargins) SetRightPct

func (c CellMargins) SetRightPct(pct float64)

SetRightPct sets the cell right margin

func (CellMargins) SetStart

func (c CellMargins) SetStart(d measurement.Distance)

SetStart sets the cell start margin

func (CellMargins) SetStartPct

func (c CellMargins) SetStartPct(pct float64)

SetStartPct sets the cell start margin

func (CellMargins) SetTop

func (c CellMargins) SetTop(d measurement.Distance)

SetTop sets the cell top margin

func (CellMargins) SetTopPct

func (c CellMargins) SetTopPct(pct float64)

SetTopPct sets the cell top margin

type CellProperties

CellProperties are a table cells properties within a document.

type CellProperties struct {
    // contains filtered or unexported fields
}

func (CellProperties) Borders

func (c CellProperties) Borders() CellBorders

Borders allows controlling individual cell borders.

func (CellProperties) Margins

func (c CellProperties) Margins() CellMargins

Margins allows controlling individual cell margins.

func (CellProperties) SetColumnSpan

func (c CellProperties) SetColumnSpan(cols int)

SetColumnSpan sets the number of Grid Columns Spanned by the Cell. This is used to give the appearance of merged cells.

func (CellProperties) SetShading

func (c CellProperties) SetShading(shd wml.ST_Shd, foreground, fill color.Color)

SetShading controls the cell shading.

func (CellProperties) SetVerticalAlignment

func (c CellProperties) SetVerticalAlignment(align wml.ST_VerticalJc)

SetVerticalAlignment sets the vertical alignment of content within a table cell.

func (CellProperties) SetVerticalMerge

func (c CellProperties) SetVerticalMerge(mergeVal wml.ST_Merge)

SetVerticalMerge controls the vertical merging of cells.

func (CellProperties) SetWidth

func (c CellProperties) SetWidth(d measurement.Distance)

SetWidth sets the cell width to a specified width.

func (CellProperties) SetWidthAuto

func (c CellProperties) SetWidthAuto()

SetWidthAuto sets the the cell width to automatic.

func (CellProperties) SetWidthPercent

func (c CellProperties) SetWidthPercent(pct float64)

SetWidthPercent sets the cell to a width percentage.

func (CellProperties) X

func (c CellProperties) X() *wml.CT_TcPr

X returns the inner wrapped XML type.

type Color

Color controls the run or styles color.

type Color struct {
    // contains filtered or unexported fields
}

func (Color) SetColor

func (c Color) SetColor(v color.Color)

SetColor sets a specific color or auto.

func (Color) SetThemeColor

func (c Color) SetThemeColor(t wml.ST_ThemeColor)

SetThemeColor sets the color from the theme.

func (Color) SetThemeShade

func (c Color) SetThemeShade(s uint8)

SetThemeShade sets the shade based off the theme color.

func (Color) X

func (c Color) X() *wml.CT_Color

X returns the inner wrapped XML type.

type DocText

DocText is an array of extracted text items which has some methods for representing extracted text.

type DocText struct {
    Items []TextItem
}

func (*DocText) Text

func (d *DocText) Text() string

Text returns text from the document as one string separated with line breaks.

type Document

Document is a text document that can be written out in the OOXML .docx format. It can be opened from a file on disk and modified, or created from scratch.

type Document struct {
    common.DocBase

    Settings  Settings  // document settings
    Numbering Numbering // numbering styles within the document
    Styles    Styles    // styles that are use and can be used within the document
    // contains filtered or unexported fields
}

func New

func New() *Document

New constructs an empty document that content can be added to.

Example

Code:

doc := document.New()
doc.AddParagraph().AddRun().AddText("Hello World!")
doc.SaveToFile("document.docx")

func Open

func Open(filename string) (*Document, error)

Open opens and reads a document from a file (.docx).

Example

Code:

doc, err := document.Open("existing.docx")
if err != nil {
    log.Fatalf("error opening document: %s", err)
}
for _, para := range doc.Paragraphs() {
    for _, run := range para.Runs() {
        fmt.Print(run.Text())
    }
    fmt.Println()
}

func OpenTemplate

func OpenTemplate(filename string) (*Document, error)

OpenTemplate opens a document, removing all content so it can be used as a template. Since Word removes unused styles from a document upon save, to create a template in Word add a paragraph with every style of interest. When opened with OpenTemplate the document's styles will be available but the content will be gone.

Example

Code:

doc, err := document.OpenTemplate("existing.docx")
if err != nil {
    log.Fatalf("error opening document template: %s", err)
}
para := doc.AddParagraph()
para.SetStyle("Title")
para.AddRun().AddText("My Document Title")

para = doc.AddParagraph()
para.SetStyle("Subtitle")
para.AddRun().AddText("Document Subtitle")

para = doc.AddParagraph()
para.SetStyle("Heading1")
para.AddRun().AddText("Major Section")
doc.SaveToFile("ouput.docx")

func Read

func Read(r io.ReaderAt, size int64) (*Document, error)

read reads a document from an io.Reader.

func (*Document) AddFooter

func (d *Document) AddFooter() Footer

AddFooter creates a Footer associated with the document, but doesn't add it to the document for display.

func (*Document) AddHeader

func (d *Document) AddHeader() Header

AddHeader creates a header associated with the document, but doesn't add it to the document for display.

func (d Document) AddHyperlink(url string) common.Hyperlink

AddHyperlink adds a hyperlink to a document. Adding the hyperlink to a document and setting it on a cell is more efficient than setting hyperlinks directly on a cell.

func (*Document) AddImage

func (d *Document) AddImage(i common.Image) (common.ImageRef, error)

AddImage adds an image to the document package, returning a reference that can be used to add the image to a run and place it in the document contents.

func (*Document) AddParagraph

func (d *Document) AddParagraph() Paragraph

AddParagraph adds a new paragraph to the document body.

func (*Document) AddTable

func (d *Document) AddTable() Table

AddTable adds a new table to the document body.

func (*Document) Append

func (d0 *Document) Append(d1orig *Document) error

Append appends a document d0 to a document d1. All settings, headers and footers remain the same as in the document d0 if they exist there, otherwise they are taken from the d1.

func (*Document) BodySection

func (d *Document) BodySection() Section

BodySection returns the default body section used for all preceding paragraphs until the previous Section. If there is no previous sections, the body section applies to the entire document.

func (Document) Bookmarks

func (d Document) Bookmarks() []Bookmark

Bookmarks returns all of the bookmarks defined in the document.

func (*Document) Close

func (d *Document) Close() error

Close closes the document, removing any temporary files that might have been created when opening a document.

func (*Document) Copy

func (d *Document) Copy() (*Document, error)

Copy makes a deep copy of the document by saving and reading it back. It can be useful to avoid sharing common data between two documents.

func (*Document) Endnote

func (d *Document) Endnote(id int64) Endnote

Endnote returns the endnote based on the ID; this can be used nicely with the run.IsEndnote() functionality.

func (*Document) Endnotes

func (d *Document) Endnotes() []Endnote

Endnotes returns the endnotes defined in the document.

func (*Document) ExtractText

func (d *Document) ExtractText() *DocText

ExtractText returns text from the document as a DocText object.

func (*Document) Footers

func (d *Document) Footers() []Footer

Footers returns the footers defined in the document.

func (*Document) Footnote

func (d *Document) Footnote(id int64) Footnote

Footnote returns the footnote based on the ID; this can be used nicely with the run.IsFootnote() functionality.

func (*Document) Footnotes

func (d *Document) Footnotes() []Footnote

Footnotes returns the footnotes defined in the document.

func (*Document) FormFields

func (d *Document) FormFields() []FormField

FormFields extracts all of the fields from a document. They can then be manipulated via the methods on the field and the document saved.

Example

Code:

doc, err := document.Open("invitation.docx")
if err != nil {
    log.Fatalf("error opening document form: %s", err)
}
for _, field := range doc.FormFields() {
    switch field.Name() {
    case "attendingEvent":
        if field.Type() == document.FormFieldTypeCheckBox {
            field.SetChecked(true)
        }
    case "name":
        if field.Type() == document.FormFieldTypeText {
            field.SetValue("John Smith")
        }
    }
}
doc.SaveToFile("invitation-respoonse.docx")

func (*Document) GetDocRelTargetByID

func (d *Document) GetDocRelTargetByID(idAttr string) string

GetDocRelTargetByID returns TargetAttr of document relationship given its IdAttr.

func (*Document) GetImageByRelID

func (d *Document) GetImageByRelID(relID string) (common.ImageRef, bool)

GetImageByRelID returns an ImageRef with the associated relation ID in the document.

func (*Document) GetImageObjByRelId

func (d *Document) GetImageObjByRelId(relId string) (common.Image, error)

GetImageObjByRelId returns a common.Image with the associated relation ID in the document.

func (*Document) GetStyleByID

func (d *Document) GetStyleByID(id string) Style

GetStyleByID returns Style by it's IdAttr.

func (*Document) GetTargetByRelId

func (d *Document) GetTargetByRelId(idAttr string) string

GetTargetByRelId returns a target path with the associated relation ID in the document.

func (*Document) HasEndnotes

func (d *Document) HasEndnotes() bool

HasEndnotes returns a bool based on the presence or abscence of endnotes within the document.

func (*Document) HasFootnotes

func (d *Document) HasFootnotes() bool

HasFootnotes returns a bool based on the presence or abscence of footnotes within the document.

func (*Document) Headers

func (d *Document) Headers() []Header

Headers returns the headers defined in the document.

func (*Document) InsertParagraphAfter

func (d *Document) InsertParagraphAfter(relativeTo Paragraph) Paragraph

InsertParagraphAfter adds a new empty paragraph after the relativeTo paragraph.

func (*Document) InsertParagraphBefore

func (d *Document) InsertParagraphBefore(relativeTo Paragraph) Paragraph

InsertParagraphBefore adds a new empty paragraph before the relativeTo paragraph.

func (*Document) InsertTableAfter

func (d *Document) InsertTableAfter(relativeTo Paragraph) Table

func (*Document) InsertTableBefore

func (d *Document) InsertTableBefore(relativeTo Paragraph) Table

func (*Document) MailMerge

func (d *Document) MailMerge(mergeContent map[string]string)

MailMerge finds mail merge fields and replaces them with the text provided. It also removes the mail merge source info from the document settings.

func (Document) MergeFields

func (d Document) MergeFields() []string

MergeFields returns the list of all mail merge fields found in the document.

func (*Document) Paragraphs

func (d *Document) Paragraphs() []Paragraph

Paragraphs returns all of the paragraphs in the document body including tables.

func (*Document) RemoveParagraph

func (d *Document) RemoveParagraph(p Paragraph)

RemoveParagraph removes a paragraph from a document.

func (*Document) Save

func (d *Document) Save(w io.Writer) error

Save writes the document to an io.Writer in the Zip package format.

func (*Document) SaveToFile

func (d *Document) SaveToFile(path string) error

SaveToFile writes the document out to a file.

func (Document) SetConformance

func (d Document) SetConformance(conformanceAttr st.ST_ConformanceClass)

SetConformance sets conformance attribute of the document as one of these values from github.com/unidoc/unioffice/schema/soo/ofc/sharedTypes: ST_ConformanceClassUnset, ST_ConformanceClassStrict or ST_ConformanceClassTransitional.

func (Document) SetStrict

func (d Document) SetStrict(strict bool)

SetStrict is a shortcut for document.SetConformance, as one of these values from github.com/unidoc/unioffice/schema/soo/ofc/sharedTypes: ST_ConformanceClassUnset, ST_ConformanceClassStrict or ST_ConformanceClassTransitional.

func (*Document) StructuredDocumentTags

func (d *Document) StructuredDocumentTags() []StructuredDocumentTag

StructuredDocumentTags returns the structured document tags in the document which are commonly used in document templates.

func (*Document) Tables

func (d *Document) Tables() []Table

Tables returns the tables defined in the document.

func (*Document) Validate

func (d *Document) Validate() error

Validate validates the structure and in cases where it't possible, the ranges of elements within a document. A validation error dones't mean that the document won't work in MS Word or LibreOffice, but it's worth checking into.

func (*Document) X

func (d *Document) X() *wml.Document

X returns the inner wrapped XML type.

type DrawingInfo

DrawingInfo is used for keep information about a drawing wrapping a textbox where the text is located.

type DrawingInfo struct {
    Drawing *wml.CT_Drawing
    Width   int64
    Height  int64
}

type Endnote

Endnote is an individual endnote reference within the document.

type Endnote struct {
    // contains filtered or unexported fields
}

func (Endnote) AddParagraph

func (e Endnote) AddParagraph() Paragraph

AddParagraph adds a paragraph to the endnote.

func (Endnote) Paragraphs

func (e Endnote) Paragraphs() []Paragraph

Paragraphs returns the paragraphs defined in an endnote.

func (Endnote) RemoveParagraph

func (e Endnote) RemoveParagraph(p Paragraph)

RemoveParagraph removes a paragraph from the endnote.

func (Endnote) X

func (e Endnote) X() *wml.CT_FtnEdn

X returns the inner wrapped XML type.

type Fonts

Fonts allows manipulating a style or run's fonts.

type Fonts struct {
    // contains filtered or unexported fields
}

func (Fonts) SetASCIITheme

func (f Fonts) SetASCIITheme(t wml.ST_Theme)

SetASCIITheme sets the font ASCII Theme.

func (Fonts) SetCSTheme

func (f Fonts) SetCSTheme(t wml.ST_Theme)

SetCSTheme sets the font complex script theme.

func (Fonts) SetEastAsiaTheme

func (f Fonts) SetEastAsiaTheme(t wml.ST_Theme)

SetEastAsiaTheme sets the font East Asia Theme.

func (Fonts) SetHANSITheme

func (f Fonts) SetHANSITheme(t wml.ST_Theme)

SetHANSITheme sets the font H ANSI Theme.

func (Fonts) X

func (f Fonts) X() *wml.CT_Fonts

X returns the inner wrapped XML type.

Footer is a footer for a document section.

type Footer struct {
    // contains filtered or unexported fields
}

func (Footer) AddImage

func (f Footer) AddImage(i common.Image) (common.ImageRef, error)

AddImage adds an image to the document package, returning a reference that can be used to add the image to a run and place it in the document contents.

func (Footer) AddParagraph

func (f Footer) AddParagraph() Paragraph

AddParagraph adds a paragraph to the footer.

func (Footer) Clear

func (f Footer) Clear()

Clear clears all content within a footer

func (Footer) Index

func (f Footer) Index() int

Index returns the index of the footer within the document. This is used to form its zip packaged filename as well as to match it with its relationship ID.

func (Footer) Paragraphs

func (f Footer) Paragraphs() []Paragraph

Paragraphs returns the paragraphs defined in a footer.

func (Footer) RemoveParagraph

func (f Footer) RemoveParagraph(p Paragraph)

RemoveParagraph removes a paragraph from a footer.

func (Footer) Tables

func (f Footer) Tables() []Table

Tables returns the tables defined in the footer.

func (Footer) X

func (f Footer) X() *wml.Ftr

X returns the inner wrapped XML type.

type Footnote

Footnote is an individual footnote reference within the document.

type Footnote struct {
    // contains filtered or unexported fields
}

func (Footnote) AddParagraph

func (f Footnote) AddParagraph() Paragraph

AddParagraph adds a paragraph to the footnote.

func (Footnote) Paragraphs

func (f Footnote) Paragraphs() []Paragraph

Paragraphs returns the paragraphs defined in a footnote.

func (Footnote) RemoveParagraph

func (f Footnote) RemoveParagraph(p Paragraph)

RemoveParagraph removes a paragraph from the footnote.

func (Footnote) X

func (f Footnote) X() *wml.CT_FtnEdn

X returns the inner wrapped XML type.

type FormField

FormField is a form within a document. It references the document, so changes to the form field wil be reflected in the document if it is saved.

type FormField struct {
    // contains filtered or unexported fields
}

func (FormField) IsChecked

func (f FormField) IsChecked() bool

IsChecked returns true if a FormFieldTypeCheckBox is checked.

func (FormField) Name

func (f FormField) Name() string

Name returns the name of the field.

func (FormField) PossibleValues

func (f FormField) PossibleValues() []string

PossibleValues returns the possible values for a FormFieldTypeDropDown.

func (FormField) SetCalcOnExit

func (f FormField) SetCalcOnExit(calcOnExit bool)

SetCalcOnExit marks if a FormField should be CalcOnExit or not.

func (FormField) SetChecked

func (f FormField) SetChecked(b bool)

SetChecked marks a FormFieldTypeCheckBox as checked or unchecked.

func (FormField) SetDefaultValue

func (f FormField) SetDefaultValue(v string)

SetDefaultValue sets the default value of a FormFieldTypeDropDown. For FormFieldTypeDropDown, the value must be one of the fields possible values.

func (FormField) SetEnabled

func (f FormField) SetEnabled(enabled bool)

SetEnabled marks a FormField as enabled or disabled.

func (FormField) SetName

func (f FormField) SetName(name string)

SetName marks sets a name attribute for a FormField.

func (FormField) SetPossibleValues

func (f FormField) SetPossibleValues(values []string)

SetPossibleValues sets possible values for a FormFieldTypeDropDown.

func (FormField) SetSize

func (f FormField) SetSize(size uint64)

SetSize sets size attribute for a FormFieldTypeCheckBox in pt.

func (FormField) SetValue

func (f FormField) SetValue(v string)

SetValue sets the value of a FormFieldTypeText or FormFieldTypeDropDown. For FormFieldTypeDropDown, the value must be one of the fields possible values.

func (FormField) Type

func (f FormField) Type() FormFieldType

Type returns the type of the field.

func (FormField) Value

func (f FormField) Value() string

Value returns the tring value of a FormFieldTypeText or FormFieldTypeDropDown.

type FormFieldType

FormFieldType is the type of the form field.

type FormFieldType byte

Form Field Type constants

const (
    FormFieldTypeUnknown FormFieldType = iota
    FormFieldTypeText
    FormFieldTypeCheckBox
    FormFieldTypeDropDown
)

func (FormFieldType) String

func (i FormFieldType) String() string

Header is a header for a document section.

type Header struct {
    // contains filtered or unexported fields
}

func (Header) AddImage

func (h Header) AddImage(i common.Image) (common.ImageRef, error)

AddImage adds an image to the document package, returning a reference that can be used to add the image to a run and place it in the document contents.

func (Header) AddParagraph

func (h Header) AddParagraph() Paragraph

AddParagraph adds a paragraph to the header.

func (Header) Clear

func (h Header) Clear()

Clear clears all content within a header

func (Header) Index

func (h Header) Index() int

Index returns the index of the header within the document. This is used to form its zip packaged filename as well as to match it with its relationship ID.

func (Header) Paragraphs

func (h Header) Paragraphs() []Paragraph

Paragraphs returns the paragraphs defined in a header.

func (Header) RemoveParagraph

func (h Header) RemoveParagraph(p Paragraph)

RemoveParagraph removes a paragraph from a footer.

func (Header) Tables

func (h Header) Tables() []Table

Tables returns the tables defined in the header.

func (Header) X

func (h Header) X() *wml.Hdr

X returns the inner wrapped XML type.

HyperLink is a link within a document.

type HyperLink struct {
    // contains filtered or unexported fields
}

func (HyperLink) AddRun

func (h HyperLink) AddRun() Run

AddRun adds a run of text to a hyperlink. This is the text that will be linked.

func (HyperLink) SetTarget

func (h HyperLink) SetTarget(url string)

SetTarget sets the URL target of the hyperlink.

func (HyperLink) SetTargetBookmark

func (h HyperLink) SetTargetBookmark(bm Bookmark)

SetTargetBookmark sets the bookmark target of the hyperlink.

func (HyperLink) SetTargetByRef

func (h HyperLink) SetTargetByRef(link common.Hyperlink)

SetTargetByRef sets the URL target of the hyperlink and is more efficient if a link destination will be used many times.

func (HyperLink) SetToolTip

func (h HyperLink) SetToolTip(text string)

SetToolTip sets the tooltip text for a hyperlink.

func (HyperLink) X

func (h HyperLink) X() *wml.CT_Hyperlink

X returns the inner wrapped XML type.

type InlineDrawing

InlineDrawing is an inlined image within a run.

type InlineDrawing struct {
    // contains filtered or unexported fields
}

func (InlineDrawing) GetImage

func (i InlineDrawing) GetImage() (common.ImageRef, bool)

GetImage returns the ImageRef associated with an InlineDrawing.

func (InlineDrawing) SetSize

func (i InlineDrawing) SetSize(w, h measurement.Distance)

SetSize sets the size of the displayed image on the page.

func (InlineDrawing) X

func (i InlineDrawing) X() *wml.WdInline

X returns the inner wrapped XML type.

type Numbering

Numbering is the document wide numbering styles contained in numbering.xml.

type Numbering struct {
    // contains filtered or unexported fields
}

func NewNumbering

func NewNumbering() Numbering

NewNumbering constructs a new numbering.

func (Numbering) AddDefinition

func (n Numbering) AddDefinition() NumberingDefinition

AddDefinition adds a new numbering definition.

func (Numbering) Clear

func (n Numbering) Clear()

Clear resets the numbering.

func (Numbering) Definitions

func (n Numbering) Definitions() []NumberingDefinition

Definitions returns the defined numbering definitions.

func (Numbering) InitializeDefault

func (n Numbering) InitializeDefault()

InitializeDefault constructs a default numbering.

func (Numbering) X

func (n Numbering) X() *wml.Numbering

X returns the inner wrapped XML type.

type NumberingDefinition

NumberingDefinition defines a numbering definition for a list of pragraphs.

type NumberingDefinition struct {
    // contains filtered or unexported fields
}

func (NumberingDefinition) AbstractNumberID

func (n NumberingDefinition) AbstractNumberID() int64

AbstractNumberID returns the ID that is unique within all numbering definitions that is used to assign the definition to a paragraph.

func (NumberingDefinition) AddLevel

func (n NumberingDefinition) AddLevel() NumberingLevel

AddLevel adds a new numbering level to a NumberingDefinition.

func (NumberingDefinition) Levels

func (n NumberingDefinition) Levels() []NumberingLevel

Levels returns all of the numbering levels defined in the definition.

func (NumberingDefinition) MultiLevelType

func (n NumberingDefinition) MultiLevelType() wml.ST_MultiLevelType

MultiLevelType returns the multilevel type, or ST_MultiLevelTypeUnset if not set.

func (NumberingDefinition) SetMultiLevelType

func (n NumberingDefinition) SetMultiLevelType(t wml.ST_MultiLevelType)

SetMultiLevelType sets the multilevel type.

func (NumberingDefinition) X

func (n NumberingDefinition) X() *wml.CT_AbstractNum

X returns the inner wrapped XML type.

type NumberingLevel

NumberingLevel is the definition for numbering for a particular level within a NumberingDefinition.

type NumberingLevel struct {
    // contains filtered or unexported fields
}

func (NumberingLevel) Properties

func (n NumberingLevel) Properties() ParagraphStyleProperties

Properties returns the numbering level paragraph properties.

func (NumberingLevel) RunProperties

func (n NumberingLevel) RunProperties() RunProperties

RunProperties returns the RunProperties controlling numbering level font, etc.

func (NumberingLevel) SetAlignment

func (n NumberingLevel) SetAlignment(j wml.ST_Jc)

SetAlignment sets the paragraph alignment

func (NumberingLevel) SetFormat

func (n NumberingLevel) SetFormat(f wml.ST_NumberFormat)

SetFormat sets the numbering format.

func (NumberingLevel) SetText

func (n NumberingLevel) SetText(t string)

SetText sets the text to be used in bullet mode.

func (NumberingLevel) X

func (n NumberingLevel) X() *wml.CT_Lvl

X returns the inner wrapped XML type.

type OnOffValue

OnOffValue represents an on/off value that can also be unset

type OnOffValue byte

OnOffValue constants

const (
    OnOffValueUnset OnOffValue = iota
    OnOffValueOff
    OnOffValueOn
)

type Paragraph

Paragraph is a paragraph within a document.

type Paragraph struct {
    // contains filtered or unexported fields
}

func (Paragraph) AddBookmark

func (p Paragraph) AddBookmark(name string) Bookmark

AddBookmark adds a bookmark to a document that can then be used from a hyperlink. Name is a document unique name that identifies the bookmark so it can be referenced from hyperlinks.

func (Paragraph) AddCheckBox

func (p Paragraph) AddCheckBox(name string) FormField

AddCheckBox adds checkbox form field to the paragraph and returns it.

func (Paragraph) AddDropdownList

func (p Paragraph) AddDropdownList(name string) FormField

AddDropdownList adds dropdown list form field to the paragraph and returns it.

func (Paragraph) AddEndnote

func (p Paragraph) AddEndnote(text string) Endnote

AddEndnote will create a new endnote and attach it to the Paragraph in the location at the end of the previous run (endnotes create their own run within the paragraph. The text given to the function is simply a convenience helper, paragraphs and runs can always be added to the text of the endnote later.

func (Paragraph) AddFootnote

func (p Paragraph) AddFootnote(text string) Footnote

AddFootnote will create a new footnote and attach it to the Paragraph in the location at the end of the previous run (footnotes create their own run within the paragraph). The text given to the function is simply a convenience helper, paragraphs and runs can always be added to the text of the footnote later.

func (p Paragraph) AddHyperLink() HyperLink

AddHyperLink adds a new hyperlink to a parapgraph.

func (Paragraph) AddRun

func (p Paragraph) AddRun() Run

AddRun adds a run to a paragraph.

func (Paragraph) AddTextInput

func (p Paragraph) AddTextInput(name string) FormField

AddTextInput adds text input form field to the paragraph and returns it.

func (Paragraph) InsertRunAfter

func (p Paragraph) InsertRunAfter(relativeTo Run) Run

InsertRunAfter inserts a run in the paragraph after the relative run.

func (Paragraph) InsertRunBefore

func (p Paragraph) InsertRunBefore(relativeTo Run) Run

InsertRunBefore inserts a run in the paragraph before the relative run.

func (Paragraph) Properties

func (p Paragraph) Properties() ParagraphProperties

Properties returns the paragraph properties.

func (Paragraph) RemoveEndnote

func (p Paragraph) RemoveEndnote(id int64)

RemoveEndnote removes a endnote from both the paragraph and the document the requested endnote must be anchored on the paragraph being referenced.

func (Paragraph) RemoveFootnote

func (p Paragraph) RemoveFootnote(id int64)

RemoveFootnote removes a footnote from both the paragraph and the document the requested footnote must be anchored on the paragraph being referenced.

func (Paragraph) RemoveRun

func (p Paragraph) RemoveRun(r Run)

RemoveRun removes a child run from a paragraph.

func (Paragraph) Runs

func (p Paragraph) Runs() []Run

Runs returns all of the runs in a paragraph.

func (Paragraph) SetFirstLineIndent

func (p Paragraph) SetFirstLineIndent(m measurement.Distance)

SetFirstLineIndent controls the indentation of the first line in a paragraph.

func (Paragraph) SetLineSpacing

func (p Paragraph) SetLineSpacing(d measurement.Distance, rule wml.ST_LineSpacingRule)

SetLineSpacing sets the spacing between lines in a paragraph.

func (Paragraph) SetNumberingDefinition

func (p Paragraph) SetNumberingDefinition(nd NumberingDefinition)

SetNumberingDefinition sets the numbering definition ID via a NumberingDefinition defined in numbering.xml

func (Paragraph) SetNumberingDefinitionByID

func (p Paragraph) SetNumberingDefinitionByID(abstractNumberID int64)

SetNumberingDefinitionByID sets the numbering definition ID directly, which must match an ID defined in numbering.xml

func (Paragraph) SetNumberingLevel

func (p Paragraph) SetNumberingLevel(listLevel int)

SetNumberingLevel sets the numbering level of a paragraph. If used, then the NumberingDefinition must also be set via SetNumberingDefinition or SetNumberingDefinitionByID.

func (Paragraph) SetStyle

func (p Paragraph) SetStyle(s string)

SetStyle sets the style of a paragraph and is identical to setting it on the paragraph's Properties()

func (Paragraph) Style

func (p Paragraph) Style() string

Style returns the style for a paragraph, or an empty string if it is unset.

func (Paragraph) X

func (p Paragraph) X() *wml.CT_P

X returns the inner wrapped XML type.

type ParagraphProperties

ParagraphProperties are the properties for a paragraph.

type ParagraphProperties struct {
    // contains filtered or unexported fields
}

func (ParagraphProperties) AddSection

func (p ParagraphProperties) AddSection(t wml.ST_SectionMark) Section

AddSection adds a new document section with an optional section break. If t is ST_SectionMarkUnset, then no break will be inserted.

func (ParagraphProperties) AddTabStop

func (p ParagraphProperties) AddTabStop(position measurement.Distance, justificaton wml.ST_TabJc, leader wml.ST_TabTlc)

AddTabStop adds a tab stop to the paragraph. It controls the position of text when using Run.AddTab()

func (ParagraphProperties) Bold

func (p ParagraphProperties) Bold() bool

Bold returns true if paragraph font is bold.

func (ParagraphProperties) Caps

func (p ParagraphProperties) Caps() bool

Caps returns true if paragraph font is capitalized.

func (ParagraphProperties) CharacterSpacingMeasure

func (p ParagraphProperties) CharacterSpacingMeasure() string

CharacterSpacingMeasure returns paragraph characters spacing with its measure which can be mm, cm, in, pt, pc or pi.

func (ParagraphProperties) CharacterSpacingValue

func (p ParagraphProperties) CharacterSpacingValue() int64

CharacterSpacingValue returns the value of characters spacing in twips (1/20 of point).

func (ParagraphProperties) ComplexSizeMeasure

func (p ParagraphProperties) ComplexSizeMeasure() string

ComplexSizeMeasure returns font with its measure which can be mm, cm, in, pt, pc or pi.

func (ParagraphProperties) ComplexSizeValue

func (p ParagraphProperties) ComplexSizeValue() float64

ComplexSizeValue returns the value of paragraph font size for complex fonts in points.

func (ParagraphProperties) DoubleStrike

func (p ParagraphProperties) DoubleStrike() bool

DoubleStrike returns true if paragraph is double striked.

func (ParagraphProperties) EastAsiaFont

func (p ParagraphProperties) EastAsiaFont() string

EastAsiaFont returns the name of paragraph font family for East Asia.

func (ParagraphProperties) Emboss

func (p ParagraphProperties) Emboss() bool

Emboss returns true if paragraph emboss is on.

func (ParagraphProperties) Font

func (p ParagraphProperties) Font() string

Font returns the name of paragraph font family.

func (ParagraphProperties) GetColor

func (p ParagraphProperties) GetColor() color.Color

GetColor returns the color.Color object representing the run color.

func (ParagraphProperties) Italic

func (p ParagraphProperties) Italic() bool

Italic returns true if paragraph font is italic.

func (ParagraphProperties) Outline

func (p ParagraphProperties) Outline() bool

Outline returns true if paragraph outline is on.

func (ParagraphProperties) RStyle

func (p ParagraphProperties) RStyle() string

RStyle returns the name of character style. It is defined here http://officeopenxml.com/WPstyleCharStyles.php

func (ParagraphProperties) RightToLeft

func (p ParagraphProperties) RightToLeft() bool

RightToLeft returns true if paragraph text goes from right to left.

func (ParagraphProperties) SetAlignment

func (p ParagraphProperties) SetAlignment(align wml.ST_Jc)

SetAlignment controls the paragraph alignment

func (ParagraphProperties) SetEndIndent

func (p ParagraphProperties) SetEndIndent(m measurement.Distance)

SetEndIndent controls the end indentation.

func (ParagraphProperties) SetFirstLineIndent

func (p ParagraphProperties) SetFirstLineIndent(m measurement.Distance)

SetFirstLineIndent controls the indentation of the first line in a paragraph.

func (ParagraphProperties) SetHangingIndent

func (p ParagraphProperties) SetHangingIndent(m measurement.Distance)

SetHangingIndent controls the indentation of the non-first lines in a paragraph.

func (ParagraphProperties) SetHeadingLevel

func (p ParagraphProperties) SetHeadingLevel(idx int)

SetHeadingLevel sets a heading level and style based on the level to a paragraph. The default styles for a new unioffice document support headings from level 1 to 8.

func (ParagraphProperties) SetKeepOnOnePage

func (p ParagraphProperties) SetKeepOnOnePage(b bool)

SetKeepOnOnePage controls if all lines in a paragraph are kept on the same page.

func (ParagraphProperties) SetKeepWithNext

func (p ParagraphProperties) SetKeepWithNext(b bool)

SetKeepWithNext controls if this paragraph should be kept with the next.

func (ParagraphProperties) SetPageBreakBefore

func (p ParagraphProperties) SetPageBreakBefore(b bool)

SetPageBreakBefore controls if there is a page break before this paragraph.

func (ParagraphProperties) SetSpacing

func (p ParagraphProperties) SetSpacing(before, after measurement.Distance)

SetSpacing sets the spacing that comes before and after the paragraph. Deprecated: See Spacing() instead which allows finer control.

func (ParagraphProperties) SetStartIndent

func (p ParagraphProperties) SetStartIndent(m measurement.Distance)

SetStartIndent controls the start indentation.

func (ParagraphProperties) SetStyle

func (p ParagraphProperties) SetStyle(s string)

SetStyle sets the style of a paragraph.

func (ParagraphProperties) SetWindowControl

func (p ParagraphProperties) SetWindowControl(b bool)

SetWindowControl controls if the first or last line of the paragraph is allowed to dispay on a separate page.

func (ParagraphProperties) Shadow

func (p ParagraphProperties) Shadow() bool

Shadow returns true if paragraph shadow is on.

func (ParagraphProperties) SizeMeasure

func (p ParagraphProperties) SizeMeasure() string

SizeMeasure returns font with its measure which can be mm, cm, in, pt, pc or pi.

func (ParagraphProperties) SizeValue

func (p ParagraphProperties) SizeValue() float64

SizeValue returns the value of paragraph font size in points.

func (ParagraphProperties) Spacing

func (p ParagraphProperties) Spacing() ParagraphSpacing

Spacing returns the paragraph spacing settings.

func (ParagraphProperties) Strike

func (p ParagraphProperties) Strike() bool

Strike returns true if paragraph is striked.

func (ParagraphProperties) Style

func (p ParagraphProperties) Style() string

Style returns the style for a paragraph, or an empty string if it is unset.

func (ParagraphProperties) Underline

func (p ParagraphProperties) Underline() wml.ST_Underline

Underline returns the type of paragraph underline.

func (ParagraphProperties) UnderlineColor

func (p ParagraphProperties) UnderlineColor() string

UnderlineColor returns the hex color value of paragraph underline.

func (ParagraphProperties) VerticalAlignment

func (p ParagraphProperties) VerticalAlignment() sharedTypes.ST_VerticalAlignRun

VerticalAlign returns the value of paragraph vertical align.

func (ParagraphProperties) X

func (p ParagraphProperties) X() *wml.CT_PPr

X returns the inner wrapped XML type.

type ParagraphSpacing

ParagraphSpacing controls the spacing for a paragraph and its lines.

type ParagraphSpacing struct {
    // contains filtered or unexported fields
}

func (ParagraphSpacing) SetAfter

func (p ParagraphSpacing) SetAfter(after measurement.Distance)

SetAfter sets the spacing that comes after the paragraph.

func (ParagraphSpacing) SetAfterAuto

func (p ParagraphSpacing) SetAfterAuto(b bool)

SetAfterAuto controls if spacing after a paragraph is automatically determined.

func (ParagraphSpacing) SetBefore

func (p ParagraphSpacing) SetBefore(before measurement.Distance)

SetBefore sets the spacing that comes before the paragraph.

func (ParagraphSpacing) SetBeforeAuto

func (p ParagraphSpacing) SetBeforeAuto(b bool)

SetBeforeAuto controls if spacing before a paragraph is automatically determined.

func (ParagraphSpacing) SetLineSpacing

func (p ParagraphSpacing) SetLineSpacing(d measurement.Distance, rule wml.ST_LineSpacingRule)

SetLineSpacing sets the spacing between lines in a paragraph.

type ParagraphStyleProperties

ParagraphStyleProperties is the styling information for a paragraph.

type ParagraphStyleProperties struct {
    // contains filtered or unexported fields
}

func (ParagraphStyleProperties) AddTabStop

func (p ParagraphStyleProperties) AddTabStop(position measurement.Distance, justificaton wml.ST_TabJc, leader wml.ST_TabTlc)

AddTabStop adds a tab stop to the paragraph.

func (ParagraphStyleProperties) SetAlignment

func (p ParagraphStyleProperties) SetAlignment(align wml.ST_Jc)

SetAlignment controls the paragraph alignment

func (ParagraphStyleProperties) SetContextualSpacing

func (p ParagraphStyleProperties) SetContextualSpacing(b bool)

SetContextualSpacing controls whether to Ignore Spacing Above and Below When Using Identical Styles

func (ParagraphStyleProperties) SetHangingIndent

func (p ParagraphStyleProperties) SetHangingIndent(m measurement.Distance)

SetHangingIndent controls the hanging indent of the paragraph.

func (ParagraphStyleProperties) SetKeepNext

func (p ParagraphStyleProperties) SetKeepNext(b bool)

SetKeepNext controls if the paragraph is kept with the next paragraph.

func (ParagraphStyleProperties) SetKeepOnOnePage

func (p ParagraphStyleProperties) SetKeepOnOnePage(b bool)

SetKeepOnOnePage controls if all lines in a paragraph are kept on the same page.

func (ParagraphStyleProperties) SetLeftIndent

func (p ParagraphStyleProperties) SetLeftIndent(m measurement.Distance)

SetLeftIndent controls the left indent of the paragraph.

func (ParagraphStyleProperties) SetOutlineLevel

func (p ParagraphStyleProperties) SetOutlineLevel(lvl int)

SetOutlineLevel sets the outline level of this style.

func (ParagraphStyleProperties) SetSpacing

func (p ParagraphStyleProperties) SetSpacing(before, after measurement.Distance)

SetSpacing sets the spacing that comes before and after the paragraph.

func (ParagraphStyleProperties) SetStartIndent

func (p ParagraphStyleProperties) SetStartIndent(m measurement.Distance)

SetStartIndent controls the start indent of the paragraph.

func (ParagraphStyleProperties) X

func (p ParagraphStyleProperties) X() *wml.CT_PPrGeneral

X returns the inner wrapped XML type.

type Row

Row is a row within a table within a document.

type Row struct {
    // contains filtered or unexported fields
}

func (Row) AddCell

func (r Row) AddCell() Cell

AddCell adds a cell to a row and returns it

func (Row) Cells

func (r Row) Cells() []Cell

Cells returns the cells defined in the table.

func (Row) Properties

func (r Row) Properties() RowProperties

Properties returns the row properties.

func (Row) X

func (r Row) X() *wml.CT_Row

X returns the inner wrapped XML type.

type RowProperties

RowProperties are the properties for a row within a table

type RowProperties struct {
    // contains filtered or unexported fields
}

func (RowProperties) SetHeight

func (r RowProperties) SetHeight(ht measurement.Distance, rule wml.ST_HeightRule)

SetHeight allows controlling the height of a row within a table.

type Run

Run is a run of text within a paragraph that shares the same formatting.

type Run struct {
    // contains filtered or unexported fields
}

func (Run) AddBreak

func (r Run) AddBreak()

AddBreak adds a line break to a run.

func (Run) AddDrawingAnchored

func (r Run) AddDrawingAnchored(img common.ImageRef) (AnchoredDrawing, error)

AddDrawingAnchored adds an anchored (floating) drawing from an ImageRef.

func (Run) AddDrawingInline

func (r Run) AddDrawingInline(img common.ImageRef) (InlineDrawing, error)

AddDrawingInline adds an inline drawing from an ImageRef.

func (Run) AddField

func (r Run) AddField(code string)

AddField adds a field (automatically computed text) to the document.

func (Run) AddFieldWithFormatting

func (r Run) AddFieldWithFormatting(code string, fmt string, isDirty bool)

AddFieldWithFormatting adds a field (automatically computed text) to the document with field specifc formatting.

func (Run) AddPageBreak

func (r Run) AddPageBreak()

AddPageBreak adds a page break to a run.

func (Run) AddTab

func (r Run) AddTab()

AddTab adds tab to a run and can be used with the the Paragraph's tab stops.

func (Run) AddText

func (r Run) AddText(s string)

AddText adds tet to a run.

func (Run) Clear

func (r Run) Clear()

Clear removes all of the content from within a run.

func (Run) ClearContent

func (r Run) ClearContent()

ClearContent clears any content in the run (text, tabs, breaks, etc.)

func (Run) DrawingAnchored

func (r Run) DrawingAnchored() []AnchoredDrawing

DrawingAnchored returns a slice of AnchoredDrawings.

func (Run) IsEndnote

func (r Run) IsEndnote() (bool, int64)

IsEndnote returns a bool based on whether the run has a footnote or not. Returns both a bool as to whether it has a footnote as well as the ID of the footnote.

func (Run) IsFootnote

func (r Run) IsFootnote() (bool, int64)

IsFootnote returns a bool based on whether the run has a footnote or not. Returns both a bool as to whether it has a footnote as well as the ID of the footnote.

func (Run) Properties

func (r Run) Properties() RunProperties

Properties returns the run properties.

func (Run) Text

func (r Run) Text() string

Text returns the underlying tet in the run.

func (Run) X

func (r Run) X() *wml.CT_R

X returns the inner wrapped XML type.

type RunProperties

RunProperties controls run styling properties

type RunProperties struct {
    // contains filtered or unexported fields
}

func (RunProperties) Bold

func (r RunProperties) Bold() bool

Bold returns true if run font is bold.

func (RunProperties) BoldValue

func (r RunProperties) BoldValue() OnOffValue

BoldValue returns the precise nature of the bold setting (unset, off or on).

func (RunProperties) Caps

func (r RunProperties) Caps() bool

Caps returns true if run font is capitalized.

func (RunProperties) CharacterSpacingMeasure

func (r RunProperties) CharacterSpacingMeasure() string

CharacterSpacingMeasure returns paragraph characters spacing with its measure which can be mm, cm, in, pt, pc or pi.

func (RunProperties) CharacterSpacingValue

func (r RunProperties) CharacterSpacingValue() int64

CharacterSpacingValue returns the value of run's characters spacing in twips (1/20 of point).

func (RunProperties) ClearColor

func (r RunProperties) ClearColor()

ClearColor clears the text color.

func (RunProperties) Color

func (r RunProperties) Color() Color

Color returns the style's Color.

func (RunProperties) ComplexSizeMeasure

func (r RunProperties) ComplexSizeMeasure() string

ComplexSizeMeasure returns font with its measure which can be mm, cm, in, pt, pc or pi.

func (RunProperties) ComplexSizeValue

func (r RunProperties) ComplexSizeValue() float64

ComplexSizeValue returns the value of run font size for complex fonts in points.

func (RunProperties) DoubleStrike

func (r RunProperties) DoubleStrike() bool

DoubleStrike returns true if run is double striked.

func (RunProperties) EastAsiaFont

func (r RunProperties) EastAsiaFont() string

EastAsiaFont returns the name of run font family for East Asia.

func (RunProperties) Emboss

func (r RunProperties) Emboss() bool

Emboss returns true if run emboss is on.

func (RunProperties) Font

func (r RunProperties) Font() string

Font returns the name of run font family.

func (RunProperties) Fonts

func (r RunProperties) Fonts() Fonts

Fonts returns the style's Fonts.

func (RunProperties) GetColor

func (r RunProperties) GetColor() color.Color

GetColor returns the color.Color object representing the run color.

func (RunProperties) IsBold

func (r RunProperties) IsBold() bool

IsBold returns true if the run has been set to bold.

func (RunProperties) IsItalic

func (r RunProperties) IsItalic() bool

IsItalic returns true if the run has been set to italics.

func (RunProperties) Italic

func (r RunProperties) Italic() bool

Italic returns true if run font is italic.

func (RunProperties) ItalicValue

func (r RunProperties) ItalicValue() OnOffValue

ItalicValue returns the precise nature of the italic setting (unset, off or on).

func (RunProperties) Outline

func (r RunProperties) Outline() bool

Outline returns true if run outline is on.

func (RunProperties) RStyle

func (r RunProperties) RStyle() string

RStyle returns the name of character style. It is defined here http://officeopenxml.com/WPstyleCharStyles.php

func (RunProperties) RightToLeft

func (r RunProperties) RightToLeft() bool

RightToLeft returns true if run text goes from right to left.

func (RunProperties) SetAllCaps

func (r RunProperties) SetAllCaps(b bool)

SetAllCaps sets the run to all caps.

func (RunProperties) SetBold

func (r RunProperties) SetBold(b bool)

SetBold sets the run to bold.

func (RunProperties) SetCharacterSpacing

func (r RunProperties) SetCharacterSpacing(size measurement.Distance)

SetCharacterSpacing sets the run's Character Spacing Adjustment.

func (RunProperties) SetColor

func (r RunProperties) SetColor(c color.Color)

SetColor sets the text color.

func (RunProperties) SetDoubleStrikeThrough

func (r RunProperties) SetDoubleStrikeThrough(b bool)

SetDoubleStrikeThrough sets the run to double strike-through.

func (RunProperties) SetEffect

func (r RunProperties) SetEffect(e wml.ST_TextEffect)

SetEffect sets a text effect on the run.

func (RunProperties) SetEmboss

func (r RunProperties) SetEmboss(b bool)

SetEmboss sets the run to embossed text.

func (RunProperties) SetFontFamily

func (r RunProperties) SetFontFamily(family string)

SetFontFamily sets the Ascii & HAnsi fonly family for a run.

func (RunProperties) SetHighlight

func (r RunProperties) SetHighlight(c wml.ST_HighlightColor)

SetHighlight highlights text in a specified color.

func (RunProperties) SetImprint

func (r RunProperties) SetImprint(b bool)

SetImprint sets the run to imprinted text.

func (RunProperties) SetItalic

func (r RunProperties) SetItalic(b bool)

SetItalic sets the run to italic.

func (RunProperties) SetKerning

func (r RunProperties) SetKerning(size measurement.Distance)

SetKerning sets the run's font kerning.

func (RunProperties) SetOutline

func (r RunProperties) SetOutline(b bool)

SetOutline sets the run to outlined text.

func (RunProperties) SetShadow

func (r RunProperties) SetShadow(b bool)

SetShadow sets the run to shadowed text.

func (RunProperties) SetSize

func (r RunProperties) SetSize(size measurement.Distance)

SetSize sets the font size for a run.

func (RunProperties) SetSmallCaps

func (r RunProperties) SetSmallCaps(b bool)

SetSmallCaps sets the run to small caps.

func (RunProperties) SetStrikeThrough

func (r RunProperties) SetStrikeThrough(b bool)

SetStrikeThrough sets the run to strike-through.

func (RunProperties) SetStyle

func (r RunProperties) SetStyle(style string)

SetStyle sets the font size.

func (RunProperties) SetUnderline

func (r RunProperties) SetUnderline(style wml.ST_Underline, c color.Color)

SetUnderline controls underline for a run style.

func (RunProperties) SetVerticalAlignment

func (r RunProperties) SetVerticalAlignment(v sharedTypes.ST_VerticalAlignRun)

SetVerticalAlignment controls the vertical alignment of the run, this is used to control if text is superscript/subscript.

func (RunProperties) Shadow

func (r RunProperties) Shadow() bool

Shadow returns true if run shadow is on.

func (RunProperties) SizeMeasure

func (r RunProperties) SizeMeasure() string

SizeMeasure returns font with its measure which can be mm, cm, in, pt, pc or pi.

func (RunProperties) SizeValue

func (r RunProperties) SizeValue() float64

SizeValue returns the value of run font size in points.

func (RunProperties) Strike

func (r RunProperties) Strike() bool

Strike returns true if run is striked.

func (RunProperties) Underline

func (r RunProperties) Underline() wml.ST_Underline

Underline returns the type of run underline.

func (RunProperties) UnderlineColor

func (r RunProperties) UnderlineColor() string

UnderlineColor returns the hex color value of run underline.

func (RunProperties) VerticalAlignment

func (r RunProperties) VerticalAlignment() sharedTypes.ST_VerticalAlignRun

VerticalAlign returns the value of run vertical align.

func (RunProperties) X

func (r RunProperties) X() *wml.CT_RPr

X returns the inner wrapped XML type.

type Section

Section is the beginning of a new section.

type Section struct {
    // contains filtered or unexported fields
}

func (Section) GetFooter

func (s Section) GetFooter(t wml.ST_HdrFtr) (Footer, bool)

GetFooter gets a section Footer for given type

func (Section) GetHeader

func (s Section) GetHeader(t wml.ST_HdrFtr) (Header, bool)

GetHeader gets a section Header for given type t [ST_HdrFtrDefault, ST_HdrFtrEven, ST_HdrFtrFirst]

func (Section) SetFooter

func (s Section) SetFooter(f Footer, t wml.ST_HdrFtr)

SetFooter sets a section footer.

func (Section) SetHeader

func (s Section) SetHeader(h Header, t wml.ST_HdrFtr)

SetHeader sets a section header.

func (Section) SetPageMargins

func (s Section) SetPageMargins(top, right, bottom, left, header, footer, gutter measurement.Distance)

SetPageMargins sets the page margins for a section

func (Section) X

func (s Section) X() *wml.CT_SectPr

X returns the internally wrapped *wml.CT_SectPr.

type Settings

Settings controls the document settings.

type Settings struct {
    // contains filtered or unexported fields
}

func NewSettings

func NewSettings() Settings

NewSettings constructs a new empty Settings

func (Settings) RemoveMailMerge

func (s Settings) RemoveMailMerge()

RemoveMailMerge removes any mail merge settings

func (Settings) SetUpdateFieldsOnOpen

func (s Settings) SetUpdateFieldsOnOpen(b bool)

SetUpdateFieldsOnOpen controls if fields are recalculated upon opening the document. This is useful for things like a table of contents as the library only adds the field code and relies on Word/LibreOffice to actually compute the content.

func (Settings) X

func (s Settings) X() *wml.Settings

X returns the inner wrapped XML type.

type StructuredDocumentTag

StructuredDocumentTag are a tagged bit of content in a document.

type StructuredDocumentTag struct {
    // contains filtered or unexported fields
}

func (StructuredDocumentTag) Paragraphs

func (s StructuredDocumentTag) Paragraphs() []Paragraph

Paragraphs returns the paragraphs within a structured document tag.

type Style

Style is a style within the styles.xml file.

type Style struct {
    // contains filtered or unexported fields
}

func (Style) Name

func (s Style) Name() string

Name returns the name of the style if set.

func (Style) ParagraphProperties

func (s Style) ParagraphProperties() ParagraphStyleProperties

ParagraphProperties returns the paragraph style properties.

func (Style) RunProperties

func (s Style) RunProperties() RunProperties

RunProperties returns the run style properties.

func (Style) SetBasedOn

func (s Style) SetBasedOn(name string)

SetBasedOn sets the style that this style is based on.

func (Style) SetLinkedStyle

func (s Style) SetLinkedStyle(name string)

SetLinkedStyle sets the style that this style is linked to.

func (Style) SetName

func (s Style) SetName(name string)

SetName sets the name of the style.

func (Style) SetNextStyle

func (s Style) SetNextStyle(name string)

SetNextStyle sets the style that the next paragraph will use.

func (Style) SetPrimaryStyle

func (s Style) SetPrimaryStyle(b bool)

SetPrimaryStyle marks the style as a primary style.

func (Style) SetSemiHidden

func (s Style) SetSemiHidden(b bool)

SetSemiHidden controls if the style is hidden in the UI.

func (Style) SetUISortOrder

func (s Style) SetUISortOrder(order int)

SetUISortOrder controls the order the style is displayed in the UI.

func (Style) SetUnhideWhenUsed

func (s Style) SetUnhideWhenUsed(b bool)

SetUnhideWhenUsed controls if a semi hidden style becomes visible when used.

func (Style) StyleID

func (s Style) StyleID() string

StyleID returns the style ID.

func (Style) TableConditionalFormatting

func (s Style) TableConditionalFormatting(typ wml.ST_TblStyleOverrideType) TableConditionalFormatting

TableConditionalFormatting returns a conditional formatting object of a given type. Calling this method repeatedly will return the same object.

func (Style) TableProperties

func (s Style) TableProperties() TableStyleProperties

TableProperties returns the table style properties.

func (Style) Type

func (s Style) Type() wml.ST_StyleType

Type returns the type of the style.

func (Style) X

func (s Style) X() *wml.CT_Style

X returns the inner wrapped XML type.

type Styles

Styles is the document wide styles contained in styles.xml.

type Styles struct {
    // contains filtered or unexported fields
}

func NewStyles

func NewStyles() Styles

NewStyles constructs a new empty Styles

func (Styles) AddStyle

func (s Styles) AddStyle(styleID string, t wml.ST_StyleType, isDefault bool) Style

AddStyle adds a new empty style.

func (Styles) Clear

func (s Styles) Clear()

Clear clears the styes.

func (Styles) InitializeDefault

func (s Styles) InitializeDefault()

InitializeDefault constructs the default styles.

func (Styles) ParagraphStyles

func (s Styles) ParagraphStyles() []Style

ParagraphStyles returns only the paragraph styles.

func (Styles) Styles

func (s Styles) Styles() []Style

Styles returns all styles.

func (Styles) X

func (s Styles) X() *wml.Styles

X returns the inner wrapped XML type.

type Table

Table is a table within a document.

type Table struct {
    // contains filtered or unexported fields
}

func (Table) AddRow

func (t Table) AddRow() Row

AddRow adds a row to a table.

func (Table) InsertRowAfter

func (t Table) InsertRowAfter(r Row) Row

InsertRowAfter inserts a row after another row

func (Table) InsertRowBefore

func (t Table) InsertRowBefore(r Row) Row

InsertRowBefore inserts a row before another row

func (Table) Properties

func (t Table) Properties() TableProperties

Properties returns the table properties.

func (Table) Rows

func (t Table) Rows() []Row

Rows returns the rows defined in the table.

func (Table) X

func (t Table) X() *wml.CT_Tbl

X returns the inner wrapped XML type.

type TableBorders

TableBorders allows manipulation of borders on a table.

type TableBorders struct {
    // contains filtered or unexported fields
}

func (TableBorders) SetAll

func (b TableBorders) SetAll(t wml.ST_Border, c color.Color, thickness measurement.Distance)

SetAll sets all of the borders to a given value.

func (TableBorders) SetBottom

func (b TableBorders) SetBottom(t wml.ST_Border, c color.Color, thickness measurement.Distance)

SetBottom sets the bottom border to a specified type, color and thickness.

func (TableBorders) SetInsideHorizontal

func (b TableBorders) SetInsideHorizontal(t wml.ST_Border, c color.Color, thickness measurement.Distance)

SetInsideHorizontal sets the interior horizontal borders to a specified type, color and thickness.

func (TableBorders) SetInsideVertical

func (b TableBorders) SetInsideVertical(t wml.ST_Border, c color.Color, thickness measurement.Distance)

SetInsideVertical sets the interior vertical borders to a specified type, color and thickness.

func (TableBorders) SetLeft

func (b TableBorders) SetLeft(t wml.ST_Border, c color.Color, thickness measurement.Distance)

SetLeft sets the left border to a specified type, color and thickness.

func (TableBorders) SetRight

func (b TableBorders) SetRight(t wml.ST_Border, c color.Color, thickness measurement.Distance)

SetRight sets the right border to a specified type, color and thickness.

func (TableBorders) SetTop

func (b TableBorders) SetTop(t wml.ST_Border, c color.Color, thickness measurement.Distance)

SetTop sets the top border to a specified type, color and thickness.

func (TableBorders) X

func (b TableBorders) X() *wml.CT_TblBorders

X returns the inner wml.CT_TblBorders

type TableConditionalFormatting

TableConditionalFormatting controls the conditional formatting within a table style.

type TableConditionalFormatting struct {
    // contains filtered or unexported fields
}

func (TableConditionalFormatting) CellProperties

func (t TableConditionalFormatting) CellProperties() CellProperties

CellProperties returns the cell properties.

func (TableConditionalFormatting) ParagraphProperties

func (t TableConditionalFormatting) ParagraphProperties() ParagraphStyleProperties

ParagraphProperties returns the paragraph properties controlling text formatting within the table.

func (TableConditionalFormatting) RunProperties

func (t TableConditionalFormatting) RunProperties() RunProperties

RunProperties returns the run properties controlling text formatting within the table.

func (TableConditionalFormatting) X

func (t TableConditionalFormatting) X() *wml.CT_TblStylePr

X returns the inner wrapped XML type.

type TableInfo

TableInfo is used for keep information about a table, a row and a cell where the text is located.

type TableInfo struct {
    Table    *wml.CT_Tbl
    Row      *wml.CT_Row
    Cell     *wml.CT_Tc
    RowIndex int
    ColIndex int
}

type TableLook

TableLook is the conditional formatting associated with a table style that has been assigned to a table.

type TableLook struct {
    // contains filtered or unexported fields
}

func (TableLook) SetFirstColumn

func (t TableLook) SetFirstColumn(on bool)

SetFirstColumn controls the conditional formatting for the first column in a table.

func (TableLook) SetFirstRow

func (t TableLook) SetFirstRow(on bool)

SetFirstRow controls the conditional formatting for the first row in a table.

func (TableLook) SetHorizontalBanding

func (t TableLook) SetHorizontalBanding(on bool)

SetHorizontalBanding controls the conditional formatting for horizontal banding.

func (TableLook) SetLastColumn

func (t TableLook) SetLastColumn(on bool)

SetLastColumn controls the conditional formatting for the last column in a table.

func (TableLook) SetLastRow

func (t TableLook) SetLastRow(on bool)

SetLastRow controls the conditional formatting for the last row in a table. This is called the 'Total' row within Word.

func (TableLook) SetVerticalBanding

func (t TableLook) SetVerticalBanding(on bool)

SetVerticalBanding controls the conditional formatting for vertical banding.

func (TableLook) X

func (t TableLook) X() *wml.CT_TblLook

X returns the inner wrapped XML type.

type TableProperties

TableProperties are the properties for a table within a document

type TableProperties struct {
    // contains filtered or unexported fields
}

func (TableProperties) Borders

func (t TableProperties) Borders() TableBorders

Borders allows manipulation of the table borders.

func (TableProperties) SetAlignment

func (t TableProperties) SetAlignment(align wml.ST_JcTable)

SetAlignment sets the alignment of a table within the page.

func (TableProperties) SetCellSpacing

func (t TableProperties) SetCellSpacing(m measurement.Distance)

SetCellSpacing sets the cell spacing within a table.

func (TableProperties) SetCellSpacingAuto

func (t TableProperties) SetCellSpacingAuto()

SetCellSpacingAuto sets the cell spacing within a table to automatic.

func (TableProperties) SetCellSpacingPercent

func (t TableProperties) SetCellSpacingPercent(pct float64)

SetCellSpacingPercent sets the cell spacing within a table to a percent width.

func (TableProperties) SetLayout

func (t TableProperties) SetLayout(l wml.ST_TblLayoutType)

SetLayout controls the table layout. wml.ST_TblLayoutTypeAutofit corresponds to "Automatically resize to fit contents" being checked, while wml.ST_TblLayoutTypeFixed corresponds to it being unchecked.

func (TableProperties) SetStyle

func (t TableProperties) SetStyle(name string)

SetStyle sets the table style name.

func (TableProperties) SetWidth

func (t TableProperties) SetWidth(d measurement.Distance)

SetWidth sets the table with to a specified width.

func (TableProperties) SetWidthAuto

func (t TableProperties) SetWidthAuto()

SetWidthAuto sets the the table width to automatic.

func (TableProperties) SetWidthPercent

func (t TableProperties) SetWidthPercent(pct float64)

SetWidthPercent sets the table to a width percentage.

func (TableProperties) TableLook

func (t TableProperties) TableLook() TableLook

TableLook returns the table look, or conditional formatting applied to a table style.

func (TableProperties) X

func (t TableProperties) X() *wml.CT_TblPr

X returns the inner wrapped XML type.

type TableStyleProperties

TableStyleProperties are table properties as defined in a style.

type TableStyleProperties struct {
    // contains filtered or unexported fields
}

func (TableStyleProperties) Borders

func (t TableStyleProperties) Borders() TableBorders

Borders allows manipulation of the table borders.

func (TableStyleProperties) SetCellSpacingAuto

func (t TableStyleProperties) SetCellSpacingAuto()

SetCellSpacingAuto sets the cell spacing within a table to automatic.

func (TableStyleProperties) SetCellSpacingPercent

func (t TableStyleProperties) SetCellSpacingPercent(pct float64)

SetCellSpacingPercent sets the cell spacing within a table to a percent width.

func (TableStyleProperties) SetColumnBandSize

func (t TableStyleProperties) SetColumnBandSize(cols int64)

SetColumnBandSize sets the number of Columns in the column band

func (TableStyleProperties) SetRowBandSize

func (t TableStyleProperties) SetRowBandSize(rows int64)

SetRowBandSize sets the number of Rows in the row band

func (TableStyleProperties) SetTableIndent

func (t TableStyleProperties) SetTableIndent(ind measurement.Distance)

SetTableIndent sets the Table Indent from the Leading Margin

func (TableStyleProperties) X

func (t TableStyleProperties) X() *wml.CT_TblPrBase

X returns the inner wrapped XML type.

type TableWidth

TableWidth controls width values in table settings.

type TableWidth struct {
    // contains filtered or unexported fields
}

func NewTableWidth

func NewTableWidth() TableWidth

NewTableWidth returns a newly intialized TableWidth

func (TableWidth) SetValue

func (s TableWidth) SetValue(m measurement.Distance)

SetValue sets the width value.

func (TableWidth) X

func (s TableWidth) X() *wml.CT_TblWidth

X returns the inner wrapped XML type.

type TextItem

TextItem is used for keeping text with references to a paragraph and run or a table, a row and a cell where it is located.

type TextItem struct {
    Text        string
    DrawingInfo *DrawingInfo
    Paragraph   *wml.CT_P
    Hyperlink   *wml.CT_Hyperlink
    Run         *wml.CT_R
    TableInfo   *TableInfo
}

func ExtractFromFooter

func ExtractFromFooter(footer *wml.Ftr) []TextItem

ExtractFromFooter returns text from the document footer as an array of TextItems.

func ExtractFromHeader

func ExtractFromHeader(header *wml.Hdr) []TextItem

ExtractFromHeader returns text from the document header as an array of TextItems.

Subdirectories

Name Synopsis
..
convert