docx

Documentation

Index

• func FindCheckBoxTag(paragraph xml.Node) (xml.Node, error)
• type CheckBox
  • func NewCheckBox(checkMark xml.Node, textNodes *[]xml.Node) *CheckBox
  • func (c *CheckBox) GetTextValue() string
  • func (c *CheckBox) IsChecked() bool
  • func (c *CheckBox) SetCheckMarkTo(value bool)

Functions

func FindCheckBoxTag

func FindCheckBoxTag(paragraph xml.Node) (xml.Node, error)

FindCheckBoxTag will look for a checkbox and the value tag. We look for the w:default or w:checked tag embedded in the w:checkBox tag because that is what we need to modify the checkbox.

Types

type CheckBox

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

CheckBox represents a checkbox in a word document with any corresponding text.

func NewCheckBox

func NewCheckBox(checkMark xml.Node, textNodes *[]xml.Node) *CheckBox

NewCheckBox constructs a new checkbox. Checks if the checkmark value can actually be found. If it cannot be found, will return nil.

func (*CheckBox) GetTextValue

func (c *CheckBox) GetTextValue() string

GetTextValue will return the corresponding text for the checkbox.

func (*CheckBox) IsChecked

func (c *CheckBox) IsChecked() bool

IsChecked will return true if the box is checked, false otherwise.

func (*CheckBox) SetCheckMarkTo

func (c *CheckBox) SetCheckMarkTo(value bool)

SetCheckMarkTo will set the checkbox state according to the input value.