unioffice: github.com/unidoc/unioffice/document Index | Examples | Files

package document

import "github.com/unidoc/unioffice/document"

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

Examples

Package Files

anchoreddrawing.go bookmark.go cell.go cellborders.go cellmargins.go cellproperties.go color.go doc.go document.go fonts.go footer.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

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

Field constants

type AnchoredDrawing Uses

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

AnchoredDrawing is an absolutely positioned image within a document page.

func (AnchoredDrawing) GetImage Uses

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

GetImage returns the ImageRef associated with an AnchoredDrawing.

func (AnchoredDrawing) SetAlignment Uses

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 Uses

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

SetHAlignment sets the horizontal alignment for an anchored image.

func (AnchoredDrawing) SetName Uses

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 Uses

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 Uses

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 Uses

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

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

func (AnchoredDrawing) SetTextWrapNone Uses

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 Uses

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

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

func (AnchoredDrawing) SetVAlignment Uses

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

SetVAlignment sets the vertical alignment for an anchored image.

func (AnchoredDrawing) SetXOffset Uses

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

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

func (AnchoredDrawing) SetYOffset Uses

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

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

func (AnchoredDrawing) X Uses

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

X returns the inner wrapped XML type.

type Bookmark Uses

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

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

func (Bookmark) Name Uses

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 Uses

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 Uses

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

X returns the inner wrapped XML type.

type Cell Uses

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

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

func (Cell) AddParagraph Uses

func (c Cell) AddParagraph() Paragraph

AddParagraph adds a paragraph to the table cell.

func (Cell) AddTable Uses

func (c Cell) AddTable() Table

AddTable adds a table to the table cell.

func (Cell) Paragraphs Uses

func (c Cell) Paragraphs() []Paragraph

Paragraphs returns the paragraphs defined in the cell.

func (Cell) Properties Uses

func (c Cell) Properties() CellProperties

Properties returns the cell properties.

func (Cell) X Uses

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

X returns the inner wrapped XML type.

type CellBorders Uses

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

CellBorders are the borders for an individual

func (CellBorders) SetAll Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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

X returns the inner wrapped type

type CellMargins Uses

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

CellMargins are the margins for an individual cell.

func (CellMargins) SetBottom Uses

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

SetBottom sets the cell bottom margin

func (CellMargins) SetBottomPct Uses

func (c CellMargins) SetBottomPct(pct float64)

SetBottomPct sets the cell bottom margin

func (CellMargins) SetLeft Uses

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

SetLeft sets the cell left margin

func (CellMargins) SetLeftPct Uses

func (c CellMargins) SetLeftPct(pct float64)

SetLeftPct sets the cell left margin

func (CellMargins) SetRight Uses

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

SetRight sets the cell right margin

func (CellMargins) SetRightPct Uses

func (c CellMargins) SetRightPct(pct float64)

SetRightPct sets the cell right margin

func (CellMargins) SetStart Uses

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

SetStart sets the cell start margin

func (CellMargins) SetStartPct Uses

func (c CellMargins) SetStartPct(pct float64)

SetStartPct sets the cell start margin

func (CellMargins) SetTop Uses

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

SetTop sets the cell top margin

func (CellMargins) SetTopPct Uses

func (c CellMargins) SetTopPct(pct float64)

SetTopPct sets the cell top margin

type CellProperties Uses

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

CellProperties are a table cells properties within a document.

func (CellProperties) Borders Uses

func (c CellProperties) Borders() CellBorders

Borders allows controlling individual cell borders.

func (CellProperties) Margins Uses

func (c CellProperties) Margins() CellMargins

Margins allows controlling individual cell margins.

func (CellProperties) SetColumnSpan Uses

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 Uses

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

SetShading controls the cell shading.

func (CellProperties) SetVerticalAlignment Uses

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

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

func (CellProperties) SetVerticalMerge Uses

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

SetVerticalMerge controls the vertical merging of cells.

func (CellProperties) SetWidth Uses

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

SetWidth sets the cell width to a specified width.

func (CellProperties) SetWidthAuto Uses

func (c CellProperties) SetWidthAuto()

SetWidthAuto sets the the cell width to automatic.

func (CellProperties) SetWidthPercent Uses

func (c CellProperties) SetWidthPercent(pct float64)

SetWidthPercent sets the cell to a width percentage.

func (CellProperties) X Uses

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

X returns the inner wrapped XML type.

type Color Uses

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

Color controls the run or styles color.

func (Color) SetColor Uses

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

SetColor sets a specific color or auto.

func (Color) SetThemeColor Uses

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

SetThemeColor sets the color from the theme.

func (Color) SetThemeShade Uses

func (c Color) SetThemeShade(s uint8)

SetThemeShade sets the shade based off the theme color.

func (Color) X Uses

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

X returns the inner wrapped XML type.

type Document Uses

type Document struct {
    common.DocBase

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

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.

func New Uses

func New() *Document

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

Code:

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

func Open Uses

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

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

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 Uses

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.

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 Uses

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

Read reads a document from an io.Reader.

func (*Document) AddFooter Uses

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 Uses

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 Uses

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 Uses

func (d *Document) AddParagraph() Paragraph

AddParagraph adds a new paragraph to the document body.

func (*Document) AddTable Uses

func (d *Document) AddTable() Table

AddTable adds a new table to the document body.

func (*Document) BodySection Uses

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 Uses

func (d Document) Bookmarks() []Bookmark

Bookmarks returns all of the bookmarks defined in the document.

func (*Document) Footers Uses

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

Footers returns the footers defined in the document.

func (*Document) FormFields Uses

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.

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) GetImageByRelID Uses

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

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

func (*Document) Headers Uses

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

Headers returns the headers defined in the document.

func (*Document) InsertParagraphAfter Uses

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

InsertParagraphAfter adds a new empty paragraph after the relativeTo paragraph.

func (*Document) InsertParagraphBefore Uses

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

InsertParagraphBefore adds a new empty paragraph before the relativeTo paragraph.

func (*Document) InsertTableAfter Uses

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

func (*Document) InsertTableBefore Uses

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

func (*Document) MailMerge Uses

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 Uses

func (d Document) MergeFields() []string

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

func (*Document) Paragraphs Uses

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

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

func (*Document) RemoveParagraph Uses

func (d *Document) RemoveParagraph(p Paragraph)

RemoveParagraph removes a paragraph from a document.

func (*Document) Save Uses

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

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

func (*Document) SaveToFile Uses

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

SaveToFile writes the document out to a file.

func (*Document) StructuredDocumentTags Uses

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

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

func (*Document) Tables Uses

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

Tables returns the tables defined in the document.

func (*Document) Validate Uses

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 Uses

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

X returns the inner wrapped XML type.

type Fonts Uses

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

Fonts allows manipulating a style or run's fonts.

func (Fonts) SetASCIITheme Uses

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

SetASCIITheme sets the font ASCII Theme.

func (Fonts) SetCSTheme Uses

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

SetCSTheme sets the font complex script theme.

func (Fonts) SetEastAsiaTheme Uses

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

SetEastAsiaTheme sets the font East Asia Theme.

func (Fonts) SetHANSITheme Uses

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

SetHANSITheme sets the font H ANSI Theme.

func (Fonts) X Uses

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

X returns the inner wrapped XML type.

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

Footer is a footer for a document section.

func (Footer) AddImage Uses

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 Uses

func (f Footer) AddParagraph() Paragraph

AddParagraph adds a paragraph to the footer.

func (Footer) Clear Uses

func (f Footer) Clear()

Clear clears all content within a footer

func (Footer) Index Uses

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 Uses

func (f Footer) Paragraphs() []Paragraph

Paragraphs returns the paragraphs defined in a footer.

func (Footer) RemoveParagraph Uses

func (f Footer) RemoveParagraph(p Paragraph)

RemoveParagraph removes a paragraph from a footer.

func (Footer) Tables Uses

func (f Footer) Tables() []Table

Tables returns the tables defined in the footer.

func (Footer) X Uses

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

X returns the inner wrapped XML type.

type FormField Uses

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

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.

func (FormField) IsChecked Uses

func (f FormField) IsChecked() bool

IsChecked returns true if a FormFieldTypeCheckBox is checked.

func (FormField) Name Uses

func (f FormField) Name() string

Name returns the name of the field.

func (FormField) PossibleValues Uses

func (f FormField) PossibleValues() []string

PossibleValues returns the possible values for a FormFieldTypeDropDown.

func (FormField) SetChecked Uses

func (f FormField) SetChecked(b bool)

SetChecked marks a FormFieldTypeCheckBox as checked or unchecked.

func (FormField) SetValue Uses

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 Uses

func (f FormField) Type() FormFieldType

Type returns the type of the field.

func (FormField) Value Uses

func (f FormField) Value() string

Value returns the tring value of a FormFieldTypeText or FormFieldTypeDropDown.

type FormFieldType Uses

type FormFieldType byte

FormFieldType is the type of the form field. go:generate stringer -type=FormFieldType

const (
    FormFieldTypeUnknown FormFieldType = iota
    FormFieldTypeText
    FormFieldTypeCheckBox
    FormFieldTypeDropDown
)

Form Field Type constants

func (FormFieldType) String Uses

func (i FormFieldType) String() string
type Header struct {
    // contains filtered or unexported fields
}

Header is a header for a document section.

func (Header) AddImage Uses

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 Uses

func (h Header) AddParagraph() Paragraph

AddParagraph adds a paragraph to the header.

func (Header) Clear Uses

func (h Header) Clear()

Clear clears all content within a header

func (Header) Index Uses

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 Uses

func (h Header) Paragraphs() []Paragraph

Paragraphs returns the paragraphs defined in a header.

func (Header) RemoveParagraph Uses

func (h Header) RemoveParagraph(p Paragraph)

RemoveParagraph removes a paragraph from a footer.

func (Header) Tables Uses

func (h Header) Tables() []Table

Tables returns the tables defined in the header.

func (Header) X Uses

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

X returns the inner wrapped XML type.

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

HyperLink is a link within a document.

func (HyperLink) AddRun Uses

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 Uses

func (h HyperLink) SetTarget(url string)

SetTarget sets the URL target of the hyperlink.

func (HyperLink) SetTargetBookmark Uses

func (h HyperLink) SetTargetBookmark(bm Bookmark)

SetTargetBookmark sets the bookmark target of the hyperlink.

func (HyperLink) SetTargetByRef Uses

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 Uses

func (h HyperLink) SetToolTip(text string)

SetToolTip sets the tooltip text for a hyperlink.

func (HyperLink) X Uses

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

X returns the inner wrapped XML type.

type InlineDrawing Uses

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

InlineDrawing is an inlined image within a run.

func (InlineDrawing) GetImage Uses

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

GetImage returns the ImageRef associated with an InlineDrawing.

func (InlineDrawing) SetSize Uses

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

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

func (InlineDrawing) X Uses

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

X returns the inner wrapped XML type.

type Numbering Uses

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

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

func NewNumbering Uses

func NewNumbering() Numbering

NewNumbering constructs a new numbering.

func (Numbering) AddDefinition Uses

func (n Numbering) AddDefinition() NumberingDefinition

AddDefinition adds a new numbering definition.

func (Numbering) Clear Uses

func (n Numbering) Clear()

Clear resets the numbering.

func (Numbering) Definitions Uses

func (n Numbering) Definitions() []NumberingDefinition

Definitions returns the defined numbering definitions.

func (Numbering) InitializeDefault Uses

func (n Numbering) InitializeDefault()

InitializeDefault constructs a default numbering.

func (Numbering) X Uses

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

X returns the inner wrapped XML type.

type NumberingDefinition Uses

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

NumberingDefinition defines a numbering definition for a list of pragraphs.

func (NumberingDefinition) AbstractNumberID Uses

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 Uses

func (n NumberingDefinition) AddLevel() NumberingLevel

AddLevel adds a new numbering level to a NumberingDefinition.

func (NumberingDefinition) Levels Uses

func (n NumberingDefinition) Levels() []NumberingLevel

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

func (NumberingDefinition) MultiLevelType Uses

func (n NumberingDefinition) MultiLevelType() wml.ST_MultiLevelType

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

func (NumberingDefinition) SetMultiLevelType Uses

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

SetMultiLevelType sets the multilevel type.

func (NumberingDefinition) X Uses

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

X returns the inner wrapped XML type.

type NumberingLevel Uses

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

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

func (NumberingLevel) Properties Uses

func (n NumberingLevel) Properties() ParagraphStyleProperties

Properties returns the numbering level paragraph properties.

func (NumberingLevel) RunProperties Uses

func (n NumberingLevel) RunProperties() RunProperties

RunProperties returns the RunProperties controlling numbering level font, etc.

func (NumberingLevel) SetAlignment Uses

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

SetAlignment sets the paragraph alignment

func (NumberingLevel) SetFormat Uses

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

SetFormat sets the numbering format.

func (NumberingLevel) SetText Uses

func (n NumberingLevel) SetText(t string)

SetText sets the text to be used in bullet mode.

func (NumberingLevel) X Uses

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

X returns the inner wrapped XML type.

type OnOffValue Uses

type OnOffValue byte

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

const (
    OnOffValueUnset OnOffValue = iota
    OnOffValueOff
    OnOffValueOn
)

OnOffValue constants

type Paragraph Uses

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

Paragraph is a paragraph within a document.

func (Paragraph) AddBookmark Uses

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 (p Paragraph) AddHyperLink() HyperLink

AddHyperLink adds a new hyperlink to a parapgraph.

func (Paragraph) AddRun Uses

func (p Paragraph) AddRun() Run

AddRun adds a run to a paragraph.

func (Paragraph) InsertRunAfter Uses

func (p Paragraph) InsertRunAfter(relativeTo Run) Run

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

func (Paragraph) InsertRunBefore Uses

func (p Paragraph) InsertRunBefore(relativeTo Run) Run

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

func (Paragraph) Properties Uses

func (p Paragraph) Properties() ParagraphProperties

Properties returns the paragraph properties.

func (Paragraph) RemoveRun Uses

func (p Paragraph) RemoveRun(r Run)

RemoveRun removes a child run from a paragraph.

func (Paragraph) Runs Uses

func (p Paragraph) Runs() []Run

Runs returns all of the runs in a paragraph.

func (Paragraph) SetNumberingDefinition Uses

func (p Paragraph) SetNumberingDefinition(nd NumberingDefinition)

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

func (Paragraph) SetNumberingDefinitionByID Uses

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 Uses

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 Uses

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 Uses

func (p Paragraph) Style() string

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

func (Paragraph) X Uses

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

X returns the inner wrapped XML type.

type ParagraphProperties Uses

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

ParagraphProperties are the properties for a paragraph.

func (ParagraphProperties) AddSection Uses

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 Uses

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) SetAlignment Uses

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

SetAlignment controls the paragraph alignment

func (ParagraphProperties) SetEndIndent Uses

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

SetEndIndent controls the end indentation.

func (ParagraphProperties) SetFirstLineIndent Uses

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

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

func (ParagraphProperties) SetHangingIndent Uses

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

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

func (ParagraphProperties) SetHeadingLevel Uses

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 gooxml document support headings from level 1 to 8.

func (ParagraphProperties) SetKeepOnOnePage Uses

func (p ParagraphProperties) SetKeepOnOnePage(b bool)

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

func (ParagraphProperties) SetKeepWithNext Uses

func (p ParagraphProperties) SetKeepWithNext(b bool)

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

func (ParagraphProperties) SetPageBreakBefore Uses

func (p ParagraphProperties) SetPageBreakBefore(b bool)

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

func (ParagraphProperties) SetSpacing Uses

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 Uses

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

SetStartIndent controls the start indentation.

func (ParagraphProperties) SetStyle Uses

func (p ParagraphProperties) SetStyle(s string)

SetStyle sets the style of a paragraph.

func (ParagraphProperties) SetWindowControl Uses

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) Spacing Uses

func (p ParagraphProperties) Spacing() ParagraphSpacing

Spacing returns the paragraph spacing settings.

func (ParagraphProperties) Style Uses

func (p ParagraphProperties) Style() string

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

func (ParagraphProperties) X Uses

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

X returns the inner wrapped XML type.

type ParagraphSpacing Uses

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

ParagraphSpacing controls the spacing for a paragraph and its lines.

func (ParagraphSpacing) SetAfter Uses

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

SetAfter sets the spacing that comes after the paragraph.

func (ParagraphSpacing) SetAfterAuto Uses

func (p ParagraphSpacing) SetAfterAuto(b bool)

SetAfterAuto controls if spacing after a paragraph is automatically determined.

func (ParagraphSpacing) SetBefore Uses

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

SetBefore sets the spacing that comes before the paragraph.

func (ParagraphSpacing) SetBeforeAuto Uses

func (p ParagraphSpacing) SetBeforeAuto(b bool)

SetBeforeAuto controls if spacing before a paragraph is automatically determined.

func (ParagraphSpacing) SetLineSpacing Uses

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

SetLineSpacing sets the spacing between lines in a paragraph.

type ParagraphStyleProperties Uses

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

ParagraphStyleProperties is the styling information for a paragraph.

func (ParagraphStyleProperties) AddTabStop Uses

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 Uses

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

SetAlignment controls the paragraph alignment

func (ParagraphStyleProperties) SetContextualSpacing Uses

func (p ParagraphStyleProperties) SetContextualSpacing(b bool)

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

func (ParagraphStyleProperties) SetHangingIndent Uses

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

SetHangingIndent controls the hanging indent of the paragraph.

func (ParagraphStyleProperties) SetKeepNext Uses

func (p ParagraphStyleProperties) SetKeepNext(b bool)

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

func (ParagraphStyleProperties) SetKeepOnOnePage Uses

func (p ParagraphStyleProperties) SetKeepOnOnePage(b bool)

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

func (ParagraphStyleProperties) SetLeftIndent Uses

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

SetLeftIndent controls the left indent of the paragraph.

func (ParagraphStyleProperties) SetOutlineLevel Uses

func (p ParagraphStyleProperties) SetOutlineLevel(lvl int)

SetOutlineLevel sets the outline level of this style.

func (ParagraphStyleProperties) SetSpacing Uses

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

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

func (ParagraphStyleProperties) SetStartIndent Uses

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

SetStartIndent controls the start indent of the paragraph.

func (ParagraphStyleProperties) X Uses

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

X returns the inner wrapped XML type.

type Row Uses

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

Row is a row within a table within a document.

func (Row) AddCell Uses

func (r Row) AddCell() Cell

AddCell adds a cell to a row and returns it

func (Row) Cells Uses

func (r Row) Cells() []Cell

Cells returns the cells defined in the table.

func (Row) Properties Uses

func (r Row) Properties() RowProperties

Properties returns the row properties.

func (Row) X Uses

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

X returns the inner wrapped XML type.

type RowProperties Uses

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

RowProperties are the properties for a row within a table

func (RowProperties) SetHeight Uses

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

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

type Run Uses

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

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

func (Run) AddBreak Uses

func (r Run) AddBreak()

AddBreak adds a line break to a run.

func (Run) AddDrawingAnchored Uses

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

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

func (Run) AddDrawingInline Uses

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

AddDrawingInline adds an inline drawing from an ImageRef.

func (Run) AddField Uses

func (r Run) AddField(code string)

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

func (Run) AddFieldWithFormatting Uses

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 Uses

func (r Run) AddPageBreak()

AddPageBreak adds a page break to a run.

func (Run) AddTab Uses

func (r Run) AddTab()

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

func (Run) AddText Uses

func (r Run) AddText(s string)

AddText adds tet to a run.

func (Run) Clear Uses

func (r Run) Clear()

Clear removes all of the content from within a run.

func (Run) ClearContent Uses

func (r Run) ClearContent()

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

func (Run) DrawingAnchored Uses

func (r Run) DrawingAnchored() []AnchoredDrawing

DrawingAnchored returns a slice of AnchoredDrawings.

func (Run) Properties Uses

func (r Run) Properties() RunProperties

Properties returns the run properties.

func (Run) Text Uses

func (r Run) Text() string

Text returns the underlying tet in the run.

func (Run) X Uses

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

X returns the inner wrapped XML type.

type RunProperties Uses

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

RunProperties controls run styling properties

func (RunProperties) BoldValue Uses

func (r RunProperties) BoldValue() OnOffValue

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

func (RunProperties) ClearColor Uses

func (r RunProperties) ClearColor()

ClearColor clears the text color.

func (RunProperties) Color Uses

func (r RunProperties) Color() Color

Color returns the style's Color.

func (RunProperties) Fonts Uses

func (r RunProperties) Fonts() Fonts

Fonts returns the style's Fonts.

func (RunProperties) IsBold Uses

func (r RunProperties) IsBold() bool

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

func (RunProperties) IsItalic Uses

func (r RunProperties) IsItalic() bool

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

func (RunProperties) ItalicValue Uses

func (r RunProperties) ItalicValue() OnOffValue

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

func (RunProperties) SetAllCaps Uses

func (r RunProperties) SetAllCaps(b bool)

SetAllCaps sets the run to all caps.

func (RunProperties) SetBold Uses

func (r RunProperties) SetBold(b bool)

SetBold sets the run to bold.

func (RunProperties) SetCharacterSpacing Uses

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

SetCharacterSpacing sets the run's Character Spacing Adjustment.

func (RunProperties) SetColor Uses

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

SetColor sets the text color.

func (RunProperties) SetDoubleStrikeThrough Uses

func (r RunProperties) SetDoubleStrikeThrough(b bool)

SetDoubleStrikeThrough sets the run to double strike-through.

func (RunProperties) SetEffect Uses

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

SetEffect sets a text effect on the run.

func (RunProperties) SetEmboss Uses

func (r RunProperties) SetEmboss(b bool)

SetEmboss sets the run to embossed text.

func (RunProperties) SetFontFamily Uses

func (r RunProperties) SetFontFamily(family string)

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

func (RunProperties) SetHighlight Uses

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

SetHighlight highlights text in a specified color.

func (RunProperties) SetImprint Uses

func (r RunProperties) SetImprint(b bool)

SetImprint sets the run to imprinted text.

func (RunProperties) SetItalic Uses

func (r RunProperties) SetItalic(b bool)

SetItalic sets the run to italic.

func (RunProperties) SetKerning Uses

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

SetKerning sets the run's font kerning.

func (RunProperties) SetOutline Uses

func (r RunProperties) SetOutline(b bool)

SetOutline sets the run to outlined text.

func (RunProperties) SetShadow Uses

func (r RunProperties) SetShadow(b bool)

SetShadow sets the run to shadowed text.

func (RunProperties) SetSize Uses

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

SetSize sets the font size for a run.

func (RunProperties) SetSmallCaps Uses

func (r RunProperties) SetSmallCaps(b bool)

SetSmallCaps sets the run to small caps.

func (RunProperties) SetStrikeThrough Uses

func (r RunProperties) SetStrikeThrough(b bool)

SetStrikeThrough sets the run to strike-through.

func (RunProperties) SetStyle Uses

func (r RunProperties) SetStyle(style string)

SetStyle sets the font size.

func (RunProperties) SetUnderline Uses

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

SetUnderline controls underline for a run style.

func (RunProperties) SetVerticalAlignment Uses

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) X Uses

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

X returns the inner wrapped XML type.

type Section Uses

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

Section is the beginning of a new section.

func (Section) SetFooter Uses

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

SetFooter sets a section footer.

func (Section) SetHeader Uses

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

SetHeader sets a section header.

func (Section) SetPageMargins Uses

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

SetPageMargins sets the page margins for a section

func (Section) X Uses

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

X returns the internally wrapped *wml.CT_SectPr.

type Settings Uses

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

Settings controls the document settings.

func NewSettings Uses

func NewSettings() Settings

NewSettings constructs a new empty Settings

func (Settings) RemoveMailMerge Uses

func (s Settings) RemoveMailMerge()

RemoveMailMerge removes any mail merge settings

func (Settings) SetUpdateFieldsOnOpen Uses

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 Uses

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

X returns the inner wrapped XML type.

type StructuredDocumentTag Uses

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

StructuredDocumentTag are a tagged bit of content in a document.

func (StructuredDocumentTag) Paragraphs Uses

func (s StructuredDocumentTag) Paragraphs() []Paragraph

Paragraphs returns the paragraphs within a structured document tag.

type Style Uses

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

Style is a style within the styles.xml file.

func (Style) Name Uses

func (s Style) Name() string

Name returns the name of the style if set.

func (Style) ParagraphProperties Uses

func (s Style) ParagraphProperties() ParagraphStyleProperties

ParagraphProperties returns the paragraph style properties.

func (Style) RunProperties Uses

func (s Style) RunProperties() RunProperties

RunProperties returns the run style properties.

func (Style) SetBasedOn Uses

func (s Style) SetBasedOn(name string)

SetBasedOn sets the style that this style is based on.

func (Style) SetLinkedStyle Uses

func (s Style) SetLinkedStyle(name string)

SetLinkedStyle sets the style that this style is linked to.

func (Style) SetName Uses

func (s Style) SetName(name string)

SetName sets the name of the style.

func (Style) SetNextStyle Uses

func (s Style) SetNextStyle(name string)

SetNextStyle sets the style that the next paragraph will use.

func (Style) SetPrimaryStyle Uses

func (s Style) SetPrimaryStyle(b bool)

SetPrimaryStyle marks the style as a primary style.

func (Style) SetSemiHidden Uses

func (s Style) SetSemiHidden(b bool)

SetSemiHidden controls if the style is hidden in the UI.

func (Style) SetUISortOrder Uses

func (s Style) SetUISortOrder(order int)

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

func (Style) SetUnhideWhenUsed Uses

func (s Style) SetUnhideWhenUsed(b bool)

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

func (Style) StyleID Uses

func (s Style) StyleID() string

StyleID returns the style ID.

func (Style) TableConditionalFormatting Uses

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 Uses

func (s Style) TableProperties() TableStyleProperties

TableProperties returns the table style properties.

func (Style) Type Uses

func (s Style) Type() wml.ST_StyleType

Type returns the type of the style.

func (Style) X Uses

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

X returns the inner wrapped XML type.

type Styles Uses

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

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

func NewStyles Uses

func NewStyles() Styles

NewStyles constructs a new empty Styles

func (Styles) AddStyle Uses

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

AddStyle adds a new empty style.

func (Styles) Clear Uses

func (s Styles) Clear()

Clear clears the styes.

func (Styles) InitializeDefault Uses

func (s Styles) InitializeDefault()

InitializeDefault constructs the default styles.

func (Styles) ParagraphStyles Uses

func (s Styles) ParagraphStyles() []Style

ParagraphStyles returns only the paragraph styles.

func (Styles) Styles Uses

func (s Styles) Styles() []Style

Styles returns all styles.

func (Styles) X Uses

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

X returns the inner wrapped XML type.

type Table Uses

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

Table is a table within a document.

func (Table) AddRow Uses

func (t Table) AddRow() Row

AddRow adds a row to a table.

func (Table) InsertRowAfter Uses

func (t Table) InsertRowAfter(r Row) Row

InsertRowAfter inserts a row after another row

func (Table) InsertRowBefore Uses

func (t Table) InsertRowBefore(r Row) Row

InsertRowBefore inserts a row before another row

func (Table) Properties Uses

func (t Table) Properties() TableProperties

Properties returns the table properties.

func (Table) Rows Uses

func (t Table) Rows() []Row

Rows returns the rows defined in the table.

func (Table) X Uses

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

X returns the inner wrapped XML type.

type TableBorders Uses

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

TableBorders allows manipulation of borders on a table.

func (TableBorders) SetAll Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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

X returns the inner wml.CT_TblBorders

type TableConditionalFormatting Uses

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

TableConditionalFormatting controls the conditional formatting within a table style.

func (TableConditionalFormatting) CellProperties Uses

func (t TableConditionalFormatting) CellProperties() CellProperties

CellProperties returns the cell properties.

func (TableConditionalFormatting) ParagraphProperties Uses

func (t TableConditionalFormatting) ParagraphProperties() ParagraphStyleProperties

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

func (TableConditionalFormatting) RunProperties Uses

func (t TableConditionalFormatting) RunProperties() RunProperties

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

func (TableConditionalFormatting) X Uses

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

X returns the inner wrapped XML type.

type TableLook Uses

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

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

func (TableLook) SetFirstColumn Uses

func (t TableLook) SetFirstColumn(on bool)

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

func (TableLook) SetFirstRow Uses

func (t TableLook) SetFirstRow(on bool)

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

func (TableLook) SetHorizontalBanding Uses

func (t TableLook) SetHorizontalBanding(on bool)

SetHorizontalBanding controls the conditional formatting for horizontal banding.

func (TableLook) SetLastColumn Uses

func (t TableLook) SetLastColumn(on bool)

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

func (TableLook) SetLastRow Uses

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 Uses

func (t TableLook) SetVerticalBanding(on bool)

SetVerticalBanding controls the conditional formatting for vertical banding.

func (TableLook) X Uses

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

X returns the inner wrapped XML type.

type TableProperties Uses

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

TableProperties are the properties for a table within a document

func (TableProperties) Borders Uses

func (t TableProperties) Borders() TableBorders

Borders allows manipulation of the table borders.

func (TableProperties) SetAlignment Uses

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

SetAlignment sets the alignment of a table within the page.

func (TableProperties) SetCellSpacing Uses

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

SetCellSpacing sets the cell spacing within a table.

func (TableProperties) SetCellSpacingAuto Uses

func (t TableProperties) SetCellSpacingAuto()

SetCellSpacingAuto sets the cell spacing within a table to automatic.

func (TableProperties) SetCellSpacingPercent Uses

func (t TableProperties) SetCellSpacingPercent(pct float64)

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

func (TableProperties) SetLayout Uses

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 Uses

func (t TableProperties) SetStyle(name string)

SetStyle sets the table style name.

func (TableProperties) SetWidth Uses

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

SetWidth sets the table with to a specified width.

func (TableProperties) SetWidthAuto Uses

func (t TableProperties) SetWidthAuto()

SetWidthAuto sets the the table width to automatic.

func (TableProperties) SetWidthPercent Uses

func (t TableProperties) SetWidthPercent(pct float64)

SetWidthPercent sets the table to a width percentage.

func (TableProperties) TableLook Uses

func (t TableProperties) TableLook() TableLook

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

func (TableProperties) X Uses

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

X returns the inner wrapped XML type.

type TableStyleProperties Uses

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

TableStyleProperties are table properties as defined in a style.

func (TableStyleProperties) Borders Uses

func (t TableStyleProperties) Borders() TableBorders

Borders allows manipulation of the table borders.

func (TableStyleProperties) SetCellSpacingAuto Uses

func (t TableStyleProperties) SetCellSpacingAuto()

SetCellSpacingAuto sets the cell spacing within a table to automatic.

func (TableStyleProperties) SetCellSpacingPercent Uses

func (t TableStyleProperties) SetCellSpacingPercent(pct float64)

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

func (TableStyleProperties) SetColumnBandSize Uses

func (t TableStyleProperties) SetColumnBandSize(cols int64)

SetColumnBandSize sets the number of Columns in the column band

func (TableStyleProperties) SetRowBandSize Uses

func (t TableStyleProperties) SetRowBandSize(rows int64)

SetRowBandSize sets the number of Rows in the row band

func (TableStyleProperties) SetTableIndent Uses

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

SetTableIndent sets the Table Indent from the Leading Margin

func (TableStyleProperties) X Uses

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

X returns the inner wrapped XML type.

type TableWidth Uses

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

TableWidth controls width values in table settings.

func NewTableWidth Uses

func NewTableWidth() TableWidth

NewTableWidth returns a newly intialized TableWidth

func (TableWidth) SetValue Uses

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

SetValue sets the width value.

func (TableWidth) X Uses

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

X returns the inner wrapped XML type.

Package document imports 26 packages (graph) and is imported by 34 packages. Updated 2019-08-06. Refresh now. Tools for package owners.