word

package module

Go to main page

Versions in this module

v0

v0.13.0

Oct 3, 2026

v0.12.2

Oct 2, 2026

v0.12.1

Oct 2, 2026

v0.12.0

Oct 2, 2026

Changes in this version

+ func RenderHTML(r io.Reader, opts HTMLOptions) ([]byte, error)

+ func RenderHTMLFile(path string, opts HTMLOptions) ([]byte, error)

+ func RenderHTMLFileWithOptions(path string, readOpts ReadOptions, htmlOpts HTMLOptions) ([]byte, error)

+ func RenderHTMLWithOptions(r io.Reader, readOpts ReadOptions, htmlOpts HTMLOptions) ([]byte, error)

type Document

+ func (d *Document) RenderHTML(opts HTMLOptions) ([]byte, error)

+ func (d *Document) RenderHTMLWithDiagnostics(opts HTMLOptions) (HTMLRenderResult, error)

+ func (d *Document) WriteHTML(w io.Writer, opts HTMLOptions) error

+ type HTMLDiagnostic struct

+ ElementType string

+ Message string

+ type HTMLImageMode string

+ const HTMLImageDataURI

+ const HTMLImageURL

+ type HTMLOptions struct

+ ImageMode HTMLImageMode

+ ImageURL func(*element.Image) (string, error)

+ IncludeCSS bool

+ IncludeHeadersFooters bool

+ Standalone bool

+ Strict bool

+ Title string

+ type HTMLRenderResult struct

+ Diagnostics []HTMLDiagnostic

+ HTML []byte

+ type HTMLUnsupportedError struct

+ Diagnostics []HTMLDiagnostic

+ func (e *HTMLUnsupportedError) Error() string

v0.11.0

Oct 1, 2026

Changes in this version

type Document

+ func NewWithOptions(opts DocumentOptions) *Document

+ type DocumentOptions struct

+ DefaultAsianFontName string

+ DefaultFontColor string

+ DefaultFontName string

+ DefaultFontSize float64

+ type PackageDiagnostic struct

+ Code string

+ Message string

+ Part string

+ Severity string

+ func ValidatePackage(data []byte) []PackageDiagnostic

v0.10.0

Sep 30, 2026

Changes in this version

+ var ErrInvalidReadOptions = errors.New("word: invalid read options")

+ var ErrReadLimitExceeded = common.ErrZipLimitExceeded

+ func StreamExtractImagesWithOptions(r io.Reader, fn func(img ImageFile) error, opts ReadOptions) error

+ func StreamExtractTextWithOptions(r io.Reader, fn func(paragraphText string) error, opts ReadOptions) error

type Document

+ func LoadBytesWithOptions(data []byte, opts ReadOptions) (*Document, error)

+ func LoadWithOptions(filename string, opts ReadOptions) (*Document, error)

+ func OpenWithOptions(filename string, opts ReadOptions) (*Document, error)

+ func ReadWithOptions(r io.Reader, opts ReadOptions) (*Document, error)

+ func (d *Document) StreamExtractImagesWithOptions(r io.Reader, fn func(img ImageFile) error, opts ReadOptions) error

+ func (d *Document) StreamExtractTextWithOptions(r io.Reader, fn func(paragraphText string) error, opts ReadOptions) error

+ type ReadOptions struct

+ MaxArchiveSize int64

+ MaxEntries int

+ MaxPartSize int64

+ MaxTotalSize int64

type TemplateProcessor

+ func NewTemplateProcessorBytesWithOptions(data []byte, opts ReadOptions) (*TemplateProcessor, error)

+ func NewTemplateProcessorWithOptions(filename string, opts ReadOptions) (*TemplateProcessor, error)

v0.9.0

Sep 26, 2026

Changes in this version

type Document

+ func (d *Document) SetImageWatermarkFile(path string, opts ...ImageWatermarkOptions) error

+ type ImageWatermarkOptions struct

+ Opacity float64

+ Scale float64

+ Washout bool

+ type WatermarkOptions struct

+ Angle float64

+ Color string

+ Cols int

+ FontName string

+ FontSize int

+ Opacity float64

+ Rows int

+ Tile bool

v0.8.0

Sep 26, 2026

Changes in this version

type Document

+ func (d *Document) AddMath(formula string) *element.Formula

+ func (d *Document) AddShape(shapeType ShapeType, opts ShapeOptions) *element.DMLShape

+ func (d *Document) AppendDocument(src *Document, opts MergeOptions) error

+ type MergeOptions struct

+ BookmarkPrefix string

+ SectionBreak string

+ StylePrefix string

+ type ShapeOptions struct

+ FillColor string

+ Font style.Font

+ Height int

+ LineColor string

+ LineWidth int

+ Text string

+ Width int

+ type ShapeType string

+ const ShapeArrow

+ const ShapeRect

+ const ShapeRoundRect

+ const ShapeTextBox

v0.7.0

Sep 26, 2026

Changes in this version

+ const ChartTypeArea

+ const ChartTypeCombo

+ const ChartTypePercentStackedArea

+ const ChartTypeStackedArea

+ const DataLabelPosBestFit

+ const DataLabelPosBottom

+ const DataLabelPosCenter

+ const DataLabelPosInBase

+ const DataLabelPosInEnd

+ const DataLabelPosLeft

+ const DataLabelPosOutEnd

+ const DataLabelPosRight

+ const DataLabelPosTop

+ const LegendBottom

+ const LegendLeft

+ const LegendRight

+ const LegendTop

+ func RegisterTemplateFilter(name string, fn func(in any, args ...string) string)

+ func StreamExtractImages(r io.Reader, fn func(img ImageFile) error) error

+ func StreamExtractText(r io.Reader, fn func(paragraphText string) error) error

+ type ChartDataLabelOptions = style.DataLabelOptions

type Document

+ func (d *Document) StreamExtractImages(r io.Reader, fn func(img ImageFile) error) error

+ func (d *Document) StreamExtractText(r io.Reader, fn func(paragraphText string) error) error

+ type TemplateFilter func(in any, args ...string) string

v0.6.0

Sep 26, 2026

Changes in this version

+ const TextDirectionHorizontal

+ const TextDirectionVertical

+ const VAlignBottom

+ const VAlignCenter

+ const VAlignTop

type Document

+ func Open(filePath string) (*Document, error)

+ func Read(r io.Reader) (*Document, error)

+ func (d *Document) AddBookmark(p *Paragraph, name string) *element.Bookmark

+ func (d *Document) AddHyperlinkToBookmark(p *Paragraph, text, bookmarkName string) *element.Link

+ func (d *Document) ExtractImages() ([]ImageFile, error)

+ func (d *Document) ExtractText() string

+ func (d *Document) GetMetadata() *metadata.DocInfo

+ type ImageFile struct

+ Data []byte

+ MIME string

+ Name string

+ type Paragraph = element.TextRun

v0.5.0

Sep 26, 2026

Changes in this version

+ const ProtectTypeComments

+ const ProtectTypeForms

+ const ProtectTypeNone

+ const ProtectTypeReadOnly

+ const ProtectTypeTrackedChanges

type Document

+ func (d *Document) AddNumPages() *element.Field

+ func (d *Document) AddPageNumber() *element.Field

+ func (d *Document) AddTableOfContents(depth ...int) *element.TOC

+ func (d *Document) Protect(editing, password string) error

+ func (d *Document) SetDifferentFirstPage(enable bool)

+ func (d *Document) SetEvenAndOddHeaders(enable bool)

+ func (d *Document) SetImageWatermark(imageBytes []byte)

+ func (d *Document) SetTextWatermark(text string)

v0.4.1

Sep 26, 2026

v0.4.0

Sep 25, 2026

Changes in this version

+ const ChartTypeBar

+ const ChartTypeColumn

+ const ChartTypeLine

+ const ChartTypePie

+ func AddMarkdown(dst htmlContainer, md string) error

type Document

+ func (d *Document) AddChart(chartType string, categories []string, seriesData ...[]float64) *element.Chart

+ func (d *Document) AddChartStyled(chartType string, categories []string, values []float64, st style.Chart) *element.Chart

+ func (d *Document) AddDeletion(text, author, date string, styles ...any) *element.Text

+ func (d *Document) AddHTML(htmlText string) error

+ func (d *Document) AddInsertion(text, author, date string, styles ...any) *element.Text

+ func (d *Document) AddMarkdown(mdText string) error

+ func (d *Document) CommentOn(text, body, author string, extras ...string) *element.Text

+ func (d *Document) EnableTrackChanges(on bool)

+ func (d *Document) TrackRevisions() bool

v0.3.0

Sep 25, 2026

Changes in this version

+ type BlockData struct

+ Blocks map[string][]BlockData

+ If map[string]bool

+ Values map[string]string

type TemplateProcessor

+ func (t *TemplateProcessor) ApplyConditionsFromValues(values map[string]string) error

+ func (t *TemplateProcessor) CloneNestedBlock(blockName string, items []BlockData) error

+ func (t *TemplateProcessor) SetCondition(name string, keep bool) error

+ func (t *TemplateProcessor) SetConditions(conds map[string]bool) error

v0.2.0

Sep 25, 2026

Changes in this version

+ type StreamWriter struct

+ func NewStreamWriter(dest io.Writer) *StreamWriter

+ func (s *StreamWriter) BytesWritten() int64

+ func (s *StreamWriter) Close() error

+ func (s *StreamWriter) WriteElement(el element.Element) error

+ func (s *StreamWriter) WriteParagraph(text string, styles ...any) error

+ func (s *StreamWriter) WriteTable(tbl *element.Table) error

v0.1.1

Sep 25, 2026

Changes in this version

+ const UnitCM

+ const UnitInch

+ const UnitMM

+ const UnitPica

+ const UnitPoint

+ const UnitTwip

+ func AddHTML(dst htmlContainer, html string, fullHTML ...bool) error

+ func DefaultAsianFontName() string

+ func DefaultFontColor() string

+ func DefaultFontName() string

+ func DefaultFontSize() float64

+ func DefaultPaper() string

+ func ExtractVariables(filename string, readerName ...string) ([]string, error)

+ func HasCompatibility() bool

+ func IsDefaultRtl() *bool

+ func IsOutputEscapingEnabled() bool

+ func MeasurementUnit() string

+ func SetCompatibility(v bool)

+ func SetDefaultAsianFontName(name string)

+ func SetDefaultFontColor(color string)

+ func SetDefaultFontName(name string)

+ func SetDefaultFontSize(size float64)

+ func SetDefaultPaper(name string)

+ func SetDefaultRtl(v *bool)

+ func SetMacroChars(open, close string)

+ func SetMacroClosingChars(s string)

+ func SetMacroOpeningChars(s string)

+ func SetMeasurementUnit(unit string)

+ func SetOutputEscapingEnabled(v bool)

+ func SetTempDir(dir string)

+ func SetZipClass(name string)

+ func TempDir() string

+ func ZipClass() string

+ type Document struct

+ func Load(filename string, readerName ...string) (*Document, error)

+ func LoadBytes(data []byte) (*Document, error)

+ func New() *Document

+ func (d *Document) AddFontStyle(name string, font any, para ...any)

+ func (d *Document) AddLinkStyle(name string, font any)

+ func (d *Document) AddNumberingStyle(name string, num any)

+ func (d *Document) AddParagraphStyle(name string, para any)

+ func (d *Document) AddSection(st ...any) *element.Section

+ func (d *Document) AddTableStyle(name string, table any, firstRow ...any)

+ func (d *Document) AddTitleStyle(depth int, font any, para ...any)

+ func (d *Document) Bytes() ([]byte, error)

+ func (d *Document) Compatibility() *metadata.Compatibility

+ func (d *Document) CountStyles() int

+ func (d *Document) DocInfo() *metadata.DocInfo

+ func (d *Document) GetBookmarks() []*element.Bookmark

+ func (d *Document) GetCharts() []*element.Chart

+ func (d *Document) GetComments() []*element.Comment

+ func (d *Document) GetCompatibility() *metadata.Compatibility

+ func (d *Document) GetDefaultAsianFontName() string

+ func (d *Document) GetDefaultFontColor() string

+ func (d *Document) GetDefaultFontName() string

+ func (d *Document) GetDefaultFontSize() float64

+ func (d *Document) GetDocInfo() *metadata.DocInfo

+ func (d *Document) GetEndnotes() []*element.Endnote

+ func (d *Document) GetFootnotes() []*element.Footnote

+ func (d *Document) GetSection(index int) *element.Section

+ func (d *Document) GetSections() []*element.Section

+ func (d *Document) GetSettings() *metadata.Settings

+ func (d *Document) GetStyle(name string) *NamedStyle

+ func (d *Document) GetStyles() []NamedStyle

+ func (d *Document) GetTitles() []*element.Title

+ func (d *Document) ResetStyles()

+ func (d *Document) Save(filename string) error

+ func (d *Document) SaveAs(filename, format string) error

+ func (d *Document) Sections() []*element.Section

+ func (d *Document) SetDefaultAsianFontName(name string)

+ func (d *Document) SetDefaultFontColor(color string)

+ func (d *Document) SetDefaultFontName(name string)

+ func (d *Document) SetDefaultFontSize(size float64)

+ func (d *Document) SetDefaultParagraphStyle(para any)

+ func (d *Document) Settings() *metadata.Settings

+ func (d *Document) SortSections(less func(a, b *element.Section) bool)

+ func (d *Document) WriteTo(dest io.Writer) (int64, error)

+ type NamedStyle struct

+ Depth int

+ FirstRow *style.Table

+ Font *style.Font

+ Kind string

+ Name string

+ Numbering *style.Numbering

+ Paragraph *style.Paragraph

+ Table *style.Table

+ type PhpWord = Document

+ type Reader interface

+ Load func(filename string) (*Document, error)

+ func CreateReader(name string) (Reader, error)

+ type TemplateProcessor struct

+ func NewTemplateProcessor(filename string) (*TemplateProcessor, error)

+ func NewTemplateProcessorBytes(data []byte) (*TemplateProcessor, error)

+ func (t *TemplateProcessor) Bytes() ([]byte, error)

+ func (t *TemplateProcessor) CloneBlock(blockName string, count int) error

+ func (t *TemplateProcessor) CloneBlockAndSetValues(blockName string, values []map[string]string) error

+ func (t *TemplateProcessor) CloneRow(search string, count int) error

+ func (t *TemplateProcessor) CloneRowAndSetValues(search string, values []map[string]string) error

+ func (t *TemplateProcessor) DeleteBlock(blockName string) error

+ func (t *TemplateProcessor) DeleteRow(search string) error

+ func (t *TemplateProcessor) GetVariableCount() map[string]int

+ func (t *TemplateProcessor) GetVariables() []string

+ func (t *TemplateProcessor) ReplaceBlock(blockName, replacement string) error

+ func (t *TemplateProcessor) ReplaceCarriageReturns(s string) string

+ func (t *TemplateProcessor) ReplaceXmlBlock(macroName, block, blockType string) error

+ func (t *TemplateProcessor) Save(filename string) error

+ func (t *TemplateProcessor) SaveAs(filename string) error

+ func (t *TemplateProcessor) SetChart(search string, ch *element.Chart) error

+ func (t *TemplateProcessor) SetCheckbox(search string, checked bool)

+ func (t *TemplateProcessor) SetComplexBlock(search string, el element.Element) error

+ func (t *TemplateProcessor) SetComplexValue(search string, el element.Element) error

+ func (t *TemplateProcessor) SetImageValue(search, path string) error

+ func (t *TemplateProcessor) SetImageValueBytes(search, filename string, data []byte) error

+ func (t *TemplateProcessor) SetMacroChars(open, close string)

+ func (t *TemplateProcessor) SetMacroClosingChars(s string)

+ func (t *TemplateProcessor) SetMacroOpeningChars(s string)

+ func (t *TemplateProcessor) SetUpdateFields(update bool)

+ func (t *TemplateProcessor) SetValue(search, replace string)

+ func (t *TemplateProcessor) SetValueLimit(search, replace string, limit int)

+ func (t *TemplateProcessor) SetValues(values map[string]string)

+ type Writer interface

+ Save func(filename string) error

+ WriteTo func(w io.Writer) (int64, error)

+ func CreateWriter(doc *Document, name string) (Writer, error)

v0.1.0

Sep 25, 2026

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