document

package

Go to main page

Versions in this module

v1

v1.1.1

Jan 21, 2020

Changes in this version

type Cell

+ func (c Cell) AddTable() Table

+ type CellMargins struct

+ 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) Margins() CellMargins

type Document

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

+ func (d Document) MergeFields() []string

type Footer

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

type NumberingDefinition

+ func (n NumberingDefinition) MultiLevelType() wml.ST_MultiLevelType

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

+ type OnOffValue byte

+ const OnOffValueOff

+ const OnOffValueOn

+ const OnOffValueUnset

type ParagraphProperties

+ func (p ParagraphProperties) Spacing() ParagraphSpacing

+ type ParagraphSpacing struct

+ 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) SetAlignment(align wml.ST_Jc)

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

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

type Run

+ func (r Run) AddPageBreak()

type RunProperties

+ func (r RunProperties) BoldValue() OnOffValue

+ func (r RunProperties) ItalicValue() OnOffValue

type Settings

+ func (s Settings) RemoveMailMerge()

type Table

+ func (t Table) InsertRowAfter(r Row) Row

+ func (t Table) InsertRowBefore(r Row) Row

v0

v0.7.1

May 25, 2018

Changes in this version

type Document

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

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

v0.7.0

Mar 31, 2018

Changes in this version

type Cell

+ func (c Cell) Paragraphs() []Paragraph

type CellProperties

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

type Document

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

type Row

+ func (r Row) Cells() []Cell

type Section

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

type Table

+ func (t Table) Rows() []Row

v0.6.0

Feb 6, 2018

Changes in this version

+ type Bookmark struct

+ func (b Bookmark) Name() string

+ func (b Bookmark) SetName(name string)

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

+ type CellBorders struct

+ 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 CellProperties

+ func (c CellProperties) Borders() CellBorders

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

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

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

+ func (c CellProperties) SetWidthAuto()

+ func (c CellProperties) SetWidthPercent(pct float64)

type Document

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

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

+ func (d *Document) RemoveParagraph(p Paragraph)

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

+ func (d Document) Bookmarks() []Bookmark

type Footer

+ func (f Footer) Clear()

+ func (f Footer) Paragraphs() []Paragraph

+ func (f Footer) RemoveParagraph(p Paragraph)

type Header

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

+ func (h Header) Clear()

+ func (h Header) Paragraphs() []Paragraph

+ func (h Header) RemoveParagraph(p Paragraph)

+ type HyperLink struct

+ 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 struct

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

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

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

type Numbering

+ func (n Numbering) AddDefinition() NumberingDefinition

+ func (n Numbering) Definitions() []NumberingDefinition

+ type NumberingDefinition struct

+ func (n NumberingDefinition) AbstractNumberID() int64

+ func (n NumberingDefinition) AddLevel() NumberingLevel

+ func (n NumberingDefinition) Levels() []NumberingLevel

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

+ type NumberingLevel struct

+ 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 Paragraph

+ func (p Paragraph) AddBookmark(name string) Bookmark

+ func (p Paragraph) AddHyperLink() HyperLink

+ func (p Paragraph) RemoveRun(r Run)

+ func (p Paragraph) SetNumberingDefinition(nd NumberingDefinition)

+ func (p Paragraph) SetNumberingDefinitionByID(abstractNumberID int64)

+ func (p Paragraph) SetNumberingLevel(listLevel int)

type ParagraphProperties

+ 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) SetStartIndent(m measurement.Distance)

type ParagraphStyleProperties

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

type Row

+ func (r Row) Properties() RowProperties

+ type RowProperties struct

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

type Run

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

+ func (r Run) Clear()

+ func (r Run) Properties() RunProperties

+ type RunProperties struct

+ func (r RunProperties) ClearColor()

+ func (r RunProperties) Color() Color

+ func (r RunProperties) Fonts() Fonts

+ func (r RunProperties) IsBold() bool

+ func (r RunProperties) IsItalic() 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) X() *wml.CT_RPr

type Style

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

+ func (s Style) TableProperties() TableStyleProperties

+ type TableConditionalFormatting struct

+ func (t TableConditionalFormatting) CellProperties() CellProperties

+ func (t TableConditionalFormatting) ParagraphProperties() ParagraphStyleProperties

+ func (t TableConditionalFormatting) RunProperties() RunProperties

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

+ type TableLook struct

+ 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) SetAlignment(align wml.ST_JcTable)

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

+ func (t TableProperties) SetStyle(name string)

+ func (t TableProperties) TableLook() TableLook

+ type TableStyleProperties struct

+ 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

v0.4.0

Sep 29, 2017

Changes in this version

type Document

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

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

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

type Paragraph

+ func (p Paragraph) InsertRunAfter(relativeTo Run) Run

+ func (p Paragraph) InsertRunBefore(relativeTo Run) Run

+ func (p Paragraph) Remove()

type Run

+ func (r Run) ClearContent()

+ func (r Run) Remove()

+ type StructuredDocumentTag struct

+ func (s StructuredDocumentTag) Paragraphs() []Paragraph

v0.3.0

Sep 19, 2017

v0.2.0

Sep 12, 2017

v0.1.0

Sep 2, 2017

Changes in this version

+ const FieldCreateDate

+ const FieldCurrentPage

+ const FieldDate

+ const FieldEditTime

+ const FieldNumberOfPages

+ const FieldPrintDate

+ const FieldSaveDate

+ const FieldTIme

+ const FieldTOC

+ type AnchoredDrawing struct

+ func (a AnchoredDrawing) GetImage() (ImageRef, bool)

+ func (a AnchoredDrawing) SetAlignment(h wd.ST_AlignH, v wd.ST_AlignV)

+ func (a AnchoredDrawing) SetHAlignment(h wd.ST_AlignH)

+ func (a AnchoredDrawing) SetName(name string)

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

+ func (a AnchoredDrawing) SetOrigin(h wd.ST_RelFromH, v wd.ST_RelFromV)

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

+ func (a AnchoredDrawing) SetTextWrapNone()

+ func (a AnchoredDrawing) SetTextWrapSquare(t wd.ST_WrapText)

+ func (a AnchoredDrawing) SetVAlignment(v wd.ST_AlignV)

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

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

+ func (a AnchoredDrawing) X() *wd.Anchor

+ type Cell struct

+ func (c Cell) AddParagraph() Paragraph

+ func (c Cell) Properties() CellProperties

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

+ type CellProperties struct

+ func (c CellProperties) SetColumnSpan(cols int)

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

+ type Color struct

+ 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 Document struct

+ Numbering Numbering

+ Settings Settings

+ Styles Styles

+ 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) AddImage(i Image) (ImageRef, error)

+ func (d *Document) AddParagraph() Paragraph

+ func (d *Document) AddTable() Table

+ func (d *Document) BodySection() Section

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

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

+ func (d *Document) Images() []ImageRef

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

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

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

+ func (d *Document) Validate() error

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

+ type Fonts struct

+ 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 struct

+ func (h Footer) AddParagraph() Paragraph

+ func (h Footer) Index() int

+ func (h Footer) X() *wml.Ftr

+ type FormField struct

+ func (f FormField) IsChecked() bool

+ func (f FormField) Name() string

+ func (f FormField) PossibleValues() []string

+ func (f FormField) SetChecked(b bool)

+ func (f FormField) SetValue(v string)

+ func (f FormField) Type() FormFieldType

+ func (f FormField) Value() string

+ type FormFieldType byte

+ const FormFieldTypeCheckBox

+ const FormFieldTypeDropDown

+ const FormFieldTypeText

+ const FormFieldTypeUnknown

+ func (i FormFieldType) String() string

+ type Header struct

+ func (h Header) AddParagraph() Paragraph

+ func (h Header) Index() int

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

+ type Image struct

+ Format string

+ Path string

+ Size image.Point

+ func ImageFromFile(path string) (Image, error)

+ type ImageRef struct

+ func (i ImageRef) Format() string

+ func (i ImageRef) Path() string

+ func (i ImageRef) RelID() string

+ type Numbering struct

+ func NewNumbering() Numbering

+ func (n Numbering) Clear()

+ func (n Numbering) InitializeDefault()

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

+ type Paragraph struct

+ func (p Paragraph) AddRun() Run

+ func (p Paragraph) Properties() ParagraphProperties

+ func (p Paragraph) Runs() []Run

+ func (p Paragraph) SetStyle(s string)

+ func (p Paragraph) Style() string

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

+ type ParagraphProperties struct

+ 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) 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) SetStyle(s string)

+ func (p ParagraphProperties) SetWindowControl(b bool)

+ func (p ParagraphProperties) Style() string

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

+ type ParagraphStyleProperties struct

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

+ func (p ParagraphStyleProperties) SetContextualSpacing(b bool)

+ func (p ParagraphStyleProperties) SetKeepNext(b bool)

+ func (p ParagraphStyleProperties) SetKeepOnOnePage(b bool)

+ func (p ParagraphStyleProperties) SetOutlineLevel(lvl int)

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

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

+ type Row struct

+ func (r Row) AddCell() Cell

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

+ type Run struct

+ func (r Run) AddBreak()

+ func (r Run) AddDrawingAnchored(img ImageRef) (AnchoredDrawing, error)

+ func (r Run) AddField(code string)

+ func (r Run) AddFieldWithFormatting(code string, fmt string)

+ func (r Run) AddTab()

+ func (r Run) AddText(s string)

+ func (r Run) ClearColor()

+ func (r Run) DrawingAnchored() []AnchoredDrawing

+ func (r Run) IsBold() bool

+ func (r Run) IsItalic() bool

+ func (r Run) SetAllCaps(b bool)

+ func (r Run) SetBold(b bool)

+ func (r Run) SetColor(c color.Color)

+ func (r Run) SetDoubleStrikeThrough(b bool)

+ func (r Run) SetEffect(e wml.ST_TextEffect)

+ func (r Run) SetEmboss(b bool)

+ func (r Run) SetFontFamily(family string)

+ func (r Run) SetFontSize(sz measurement.Distance)

+ func (r Run) SetHighlight(c wml.ST_HighlightColor)

+ func (r Run) SetImprint(b bool)

+ func (r Run) SetItalic(b bool)

+ func (r Run) SetOutline(b bool)

+ func (r Run) SetShadow(b bool)

+ func (r Run) SetSmallCaps(b bool)

+ func (r Run) SetStrikeThrough(b bool)

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

+ func (r Run) Text() string

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

+ type RunStyleProperties struct

+ func (r RunStyleProperties) Color() Color

+ func (r RunStyleProperties) Fonts() Fonts

+ func (r RunStyleProperties) SetCharacterSpacing(size measurement.Distance)

+ func (r RunStyleProperties) SetKerning(size measurement.Distance)

+ func (r RunStyleProperties) SetSize(size measurement.Distance)

+ func (r RunStyleProperties) X() *wml.CT_RPr

+ type Section struct

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

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

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

+ type Settings struct

+ func NewSettings() Settings

+ func (s Settings) SetUpdateFieldsOnOpen(b bool)

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

+ type Style struct

+ func (s Style) Name() string

+ func (s Style) ParagraphProperties() ParagraphStyleProperties

+ func (s Style) RunProperties() RunStyleProperties

+ 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) Type() wml.ST_StyleType

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

+ type Styles struct

+ 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 struct

+ func (t Table) AddRow() Row

+ func (t Table) Properties() TableProperties

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

+ type TableBorders struct

+ 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 TableProperties struct

+ func (t TableProperties) Borders() TableBorders

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

+ func (t TableProperties) SetCellSpacingAuto()

+ func (t TableProperties) SetCellSpacingPercent(pct float64)

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

+ func (t TableProperties) SetWidthAuto()

+ func (t TableProperties) SetWidthPercent(pct float64)

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

+ type TableWidth struct

+ func NewTableWidth() TableWidth

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

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

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL