docx

Aug 25, 2023

Changes in this version

type Document

+ func (d *Document) GetPlaceHoldersList() ([]string, error)

May 16, 2023

Changes in this version

+ func ChangeOpenCloseDelimiter(openDelimiter, closeDelimiter rune)

Feb 4, 2021

Changes in this version

type Placeholder

+ func (p Placeholder) Valid() bool

type PlaceholderFragment

+ func (p PlaceholderFragment) Valid() bool

type Position

+ func (p Position) Valid() bool

Feb 2, 2021

Changes in this version

+ var ErrTagsInvalid = errors.New("one or more tags are invalid and will cause the XML to be corrupt")

+ var TextCloseTagRegex = regexp.MustCompile(`(</w:t>)`)

+ var TextOpenTagRegex = regexp.MustCompile(`(<w:t).*>`)

+ func ValidatePositions(document []byte, runs []*Run) error

type Position

+ func (p Position) Match(regexp *regexp.Regexp, data []byte) bool

+ type TagPair struct

+ CloseTag Position

+ OpenTag Position

Feb 1, 2021

Changes in this version

+ const RunElementName

+ const TextElementName

+ var ErrParsingFailed = errors.New("failed to parse the document, cannot continue")

+ var RunCloseTagRegex = regexp.MustCompile(`(</w:r>)`)

+ var RunOpenTagRegex = regexp.MustCompile(`(<w:r).*>`)

+ var RunSingletonTagRegex = regexp.MustCompile(`(<w:r/>)`)

+ var TextRunCloseTagRegex = regexp.MustCompile(`(</w:t>)`)

+ var TextRunOpenTagRegex = regexp.MustCompile(`(<w:t).*>`)

+ func ResetFragmentIdCounter()

+ func ResetRunIdCounter()

+ func ValidateRuns(document []byte, runs []*Run) error

type DocumentRuns

+ func (dr *DocumentRuns) Pop() *Run

+ func (dr *DocumentRuns) Push(run *Run)

Jan 24, 2021

Changes in this version

+ func NewFragmentID() int

+ func NewRunID() int

type PlaceholderFragment

+ ID int

+ func NewPlaceholderFragment(number int, pos Position, run *Run) *PlaceholderFragment

+ func (p *PlaceholderFragment) ShiftAll(deltaLength int64)

+ func (p *PlaceholderFragment) ShiftCut(cutLength int64)

+ func (p *PlaceholderFragment) ShiftReplace(deltaLength int64)

type Run

+ ID int

+ func NewEmptyRun() *Run

+ func (r *Run) String(bytes []byte) string

Oct 15, 2020

Changes in this version

+ const CloseDelimiter

+ const DocumentXml

+ const OpenDelimiter

+ var CloseDelimiterRegex = regexp.MustCompile(string(CloseDelimiter))

+ var ErrPlaceholderNotFound = errors.New("placeholder not found in document")

+ var FooterPathRegex = regexp.MustCompile(`word/footer[0-9]*.xml`)

+ var HeaderPathRegex = regexp.MustCompile(`word/header[0-9]*.xml`)

+ var OpenDelimiterRegex = regexp.MustCompile(string(OpenDelimiter))

+ func AddPlaceholderDelimiter(s string) string

+ func IsDelimitedPlaceholder(s string) bool

+ func RemovePlaceholderDelimiter(s string) string

+ type Document struct

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

+ func OpenBytes(b []byte) (*Document, error)

+ func (d *Document) Close()

+ func (d *Document) GetFile(fileName string) []byte

+ func (d *Document) Placeholders() (placeholders []*Placeholder)

+ func (d *Document) Replace(key, value string) error

+ func (d *Document) ReplaceAll(placeholderMap PlaceholderMap) error

+ func (d *Document) Runs() (runs []*Run)

+ func (d *Document) SetFile(fileName string, fileBytes []byte) error

+ func (d *Document) Write(writer io.Writer) error

+ func (d *Document) WriteToFile(file string) error

+ type DocumentFile interface

+ DocumentBytes func() []byte

+ FooterBytes func() [][]byte

+ HeaderBytes func() [][]byte

+ type DocumentRuns []*Run

+ func (dr DocumentRuns) WithText() DocumentRuns

+ type FileMap map[string][]byte

+ func (fm FileMap) Write(writer io.Writer, filename string) error

+ type Placeholder struct

+ Fragments []*PlaceholderFragment

+ func ParsePlaceholders(runs DocumentRuns, docBytes []byte) (placeholders []*Placeholder)

+ func (p Placeholder) EndPos() int64

+ func (p Placeholder) StartPos() int64

+ func (p Placeholder) Text(docBytes []byte) string

+ type PlaceholderFragment struct

+ Number int

+ Position Position

+ Run *Run

+ func (p PlaceholderFragment) EndPos() int64

+ func (p PlaceholderFragment) StartPos() int64

+ func (p PlaceholderFragment) String(docBytes []byte) string

+ func (p PlaceholderFragment) Text(docBytes []byte) string

+ func (p PlaceholderFragment) TextLength(docBytes []byte) int64

+ type PlaceholderMap map[string]interface

+ type Position struct

+ End int64

+ Start int64

+ func TagPosition(endPos int64, tag string) (tp Position)

+ type Reader struct

+ func NewReader(s string) *Reader

+ func (r *Reader) Len() int

+ func (r *Reader) Pos() int64

+ func (r *Reader) Read(b []byte) (int, error)

+ func (r *Reader) ReadByte() (byte, error)

+ func (r *Reader) Size() int64

+ func (r *Reader) String() string

+ type Replacer struct

+ BytesChanged int64

+ ReplaceCount int

+ func NewReplacer(docBytes []byte, placeholder []*Placeholder) *Replacer

+ func (r *Replacer) Bytes() []byte

+ func (r *Replacer) Replace(placeholderKey string, value string) error

+ type Run struct

+ CloseTag Position

+ HasText bool

+ OpenTag Position

+ Text TextRun

+ func (r *Run) GetText(documentBytes []byte) string

+ type RunParser struct

+ func NewRunParser(doc []byte) *RunParser

+ func (parser *RunParser) Execute() error

+ func (parser *RunParser) Runs() DocumentRuns

+ type TextRun struct

+ EndTag Position

+ StartTag Position