Skip to content
/ gord Public

Gord is a library to operate MS Word using go-ole library.

License

Notifications You must be signed in to change notification settings

devlights/gord

Repository files navigation

gord

Gord is a library to operate MS Word using go-ole library. Thanks go-ole package!

This library works only on Windows.

Install

go get github.com/devlights/gord@latest

Usages

package main

import (
	"fmt"
	"os"
	"time"

	"github.com/devlights/gord"
)

type (
	filePath = string
)

// main is entry point of this app.
func main() {
	if len(os.Args) < 2 {
		_, _ = fmt.Fprintf(os.Stderr, "need file-path")
		os.Exit(1)
	}

	if err := run(os.Args[len(os.Args)-1]); err != nil {
		panic(err)
	}
}

func run(p filePath) error {
	// 0. Initialize Gord
	quitFn := gord.MustInitGord()
	defer quitFn()

	// 1. Create new Gord instance.
	g, release := gord.MustNewGord()

	// must call gord release function when function exited
	// otherwise WORD process was remained.
	defer release()

	// optional settings
	g.MustSetVisible(true)

	// 2. Get Documents instance.
	docs, err := g.Documents()
	if err != nil {
		return err
	}

	// 3. Open document
	doc, docReleaseFn, err := docs.Open(p)
	if err != nil {
		return err
	}

	// call document's release function
	defer docReleaseFn()

	// simulate something processing..
	time.Sleep(5 * time.Second)

	// 4. Close document
	if err := doc.Close(); err != nil {
		return err
	}

	// Document::SetSaved(true) and Document::Close() is automatically called when `defer docReleaseFn()`.
	// Word::Quit() and Word::Release() is automatically called when `defer release()`.

	return nil
}

Also look at the "examples" directory :)

REFERENCES

See also

  • Goxcel
    • Goxcel is a library to operate Excel using go-ole library.