Version holds version information, when bumping this make sure to bump the released at stamp also.
const Version = "1.38.0"
var ReleasedAt = time.Date(releaseYear, releaseMonth, releaseDay, releaseHour, releaseMin, 0, 0, time.UTC)
func AddImageToZip(z *zip.Writer, img ImageRef, imageNum int, dt unioffice.DocType) error
AddImageToZip adds an image (either from bytes or from disk) and adds it to the zip file.
func UtcTimeFormat(t time.Time) string
AppProperties contains properties specific to the document and the application that created it.
type AppProperties struct {
// contains filtered or unexported fields
}
func NewAppProperties() AppProperties
NewAppProperties constructs a new AppProperties.
func (a AppProperties) Application() string
Application returns the name of the application that created the document. For unioffice created documents, it defaults to github.com/unidoc/unioffice
func (a AppProperties) ApplicationVersion() string
ApplicationVersion returns the version of the application that created the document.
func (a AppProperties) Company() string
Company returns the name of the company that created the document. For unioffice created documents, it defaults to github.com/unidoc/unioffice
func (a AppProperties) Pages() int32
Pages returns total number of pages which are saved by the text editor which produced the document. For unioffice created documents, it is 0.
func (a AppProperties) SetApplication(s string)
SetApplication sets the name of the application that created the document.
func (a AppProperties) SetApplicationVersion(s string)
SetApplicationVersion sets the version of the application that created the document. Per MS, the verison string mut be in the form 'XX.YYYY'.
func (a AppProperties) SetCompany(s string)
SetCompany sets the name of the company that created the document.
func (a AppProperties) SetDocSecurity(v int32)
SetDocSecurity sets the document security flag.
func (a AppProperties) SetLinksUpToDate(v bool)
SetLinksUpToDate sets the links up to date flag.
func (a AppProperties) SetPages(n int32)
SetPages sets the pages count of the document.
func (a AppProperties) X() *extended_properties.Properties
X returns the inner wrapped XML type.
ContentTypes is the top level "[Content_Types].xml" in a zip package.
type ContentTypes struct {
// contains filtered or unexported fields
}
func NewContentTypes() ContentTypes
NewContentTypes returns a wrapper around a newly constructed content-types.
func (c ContentTypes) AddDefault(fileExtension string, contentType string)
AddDefault registers a default content type for a given file extension.
func (c ContentTypes) AddOverride(path, contentType string)
AddOverride adds an override content type for a given path name.
func (c ContentTypes) CopyOverride(path, newPath string)
CopyOverride copies override content type for a given `path` and puts it with a path `newPath`.
func (c ContentTypes) EnsureDefault(ext, contentType string)
EnsureDefault esnures that an extension and default content type exist, adding it if necessary.
func (c ContentTypes) EnsureOverride(path, contentType string)
EnsureOverride ensures that an override for the given path exists, adding it if necessary
func (c ContentTypes) RemoveOverride(path string)
RemoveOverride removes an override given a path.
func (c ContentTypes) RemoveOverrideByIndex(path string, indexToFind int) error
RemoveOverrideByIndex removes an override given a path and override index.
func (c ContentTypes) X() *content_types.Types
X returns the inner raw content types.
CoreProperties contains document specific properties.
type CoreProperties struct {
// contains filtered or unexported fields
}
func NewCoreProperties() CoreProperties
NewCoreProperties constructs a new CoreProperties.
func (c CoreProperties) Author() string
Author returns the author of the document
func (c CoreProperties) Category() string
Category returns the category of the document
func (c CoreProperties) ContentStatus() string
ContentStatus returns the content status of the document (e.g. "Final", "Draft")
func (c CoreProperties) Created() time.Time
Created returns the time that the document was created.
func (c CoreProperties) Description() string
Description returns the description of the document
func (c CoreProperties) LastModifiedBy() string
LastModifiedBy returns the name of the last person to modify the document
func (c CoreProperties) Modified() time.Time
Modified returns the time that the document was modified.
func (c CoreProperties) SetAuthor(s string)
SetAuthor records the author of the document.
func (c CoreProperties) SetCategory(s string)
SetCategory records the category of the document.
func (c CoreProperties) SetContentStatus(s string)
SetContentStatus records the content status of the document.
func (c CoreProperties) SetCreated(t time.Time)
SetCreated sets the time that the document was created.
func (c CoreProperties) SetDescription(s string)
SetDescription records the description of the document.
func (c CoreProperties) SetLanguage(s string)
SetLanguage records the language of the document.
func (c CoreProperties) SetLastModifiedBy(s string)
SetLastModifiedBy records the last person to modify the document.
func (c CoreProperties) SetModified(t time.Time)
SetModified sets the time that the document was modified.
func (c CoreProperties) SetTitle(s string)
SetTitle records the title of the document.
func (c CoreProperties) Title() string
Title returns the Title of the document
func (c CoreProperties) X() *core_properties.CoreProperties
X returns the inner wrapped XML type.
CustomProperties contains document specific properties.
type CustomProperties struct {
// contains filtered or unexported fields
}
func NewCustomProperties() CustomProperties
NewCustomProperties constructs a new CustomProperties.
func (c CustomProperties) GetPropertyByName(name string) CustomProperty
GetPropertyByName returns a custom property selected by it's name.
func (c CustomProperties) PropertiesList() []*custom_properties.CT_Property
PropertiesList returns the list of all custom properties of the document.
func (c CustomProperties) SetPropertyAsArray(name string, array *docPropsVTypes.Array)
func (c CustomProperties) SetPropertyAsBlob(name, blob string)
func (c CustomProperties) SetPropertyAsBool(name string, b bool)
func (c CustomProperties) SetPropertyAsBstr(name string, bstr string)
func (c CustomProperties) SetPropertyAsClsid(name string, clsid string)
func (c CustomProperties) SetPropertyAsCy(name string, cy string)
func (c CustomProperties) SetPropertyAsDate(name string, date time.Time)
func (c CustomProperties) SetPropertyAsDecimal(name string, decimal float64)
func (c CustomProperties) SetPropertyAsEmpty(name string)
func (c CustomProperties) SetPropertyAsError(name string, error string)
func (c CustomProperties) SetPropertyAsFiletime(name string, filetime time.Time)
func (c CustomProperties) SetPropertyAsI1(name string, i1 int8)
func (c CustomProperties) SetPropertyAsI2(name string, i2 int16)
func (c CustomProperties) SetPropertyAsI4(name string, i4 int32)
func (c CustomProperties) SetPropertyAsI8(name string, i8 int64)
func (c CustomProperties) SetPropertyAsInt(name string, i int)
func (c CustomProperties) SetPropertyAsLpstr(name string, lpstr string)
func (c CustomProperties) SetPropertyAsLpwstr(name string, lpwstr string)
func (c CustomProperties) SetPropertyAsNull(name string)
func (c CustomProperties) SetPropertyAsOblob(name, oblob string)
func (c CustomProperties) SetPropertyAsOstorage(name string, ostorage string)
func (c CustomProperties) SetPropertyAsOstream(name string, ostream string)
func (c CustomProperties) SetPropertyAsR4(name string, r4 float32)
func (c CustomProperties) SetPropertyAsR8(name string, r8 float64)
func (c CustomProperties) SetPropertyAsStorage(name string, storage string)
func (c CustomProperties) SetPropertyAsStream(name string, stream string)
func (c CustomProperties) SetPropertyAsUi1(name string, ui1 uint8)
func (c CustomProperties) SetPropertyAsUi2(name string, ui2 uint16)
func (c CustomProperties) SetPropertyAsUi4(name string, ui4 uint32)
func (c CustomProperties) SetPropertyAsUi8(name string, ui8 uint64)
func (c CustomProperties) SetPropertyAsUint(name string, ui uint)
func (c CustomProperties) SetPropertyAsVector(name string, vector *docPropsVTypes.Vector)
func (c CustomProperties) SetPropertyAsVstream(name string, vstream *docPropsVTypes.Vstream)
func (c CustomProperties) X() *custom_properties.Properties
X returns the inner wrapped XML type.
CustomProperty contains document specific property. Using of this type is deprecated.
type CustomProperty struct {
// contains filtered or unexported fields
}
func (c CustomProperty) X() *custom_properties.CT_Property
X returns the inner wrapped XML type of CustomProperty.
DocBase is the type embedded in in the Document/Workbook/Presentation types that contains members common to all.
type DocBase struct {
ContentTypes ContentTypes
AppProperties AppProperties
Rels Relationships
CoreProperties CoreProperties
CustomProperties CustomProperties
Thumbnail image.Image // thumbnail preview of the document
Images []ImageRef
ExtraFiles []ExtraFile
TmpPath string // path where temporary files are stored when opening documents
}
func (d *DocBase) AddCustomRelationships()
AddCustomRelationships adds relationships related to custom properties to the document.
func (d *DocBase) AddExtraFileFromZip(f *zip.File) error
AddExtraFileFromZip is used when reading an unsupported file from an OOXML file. This ensures that unsupported file content will at least round-trip correctly.
func (docBase0 DocBase) Append(docBase1 DocBase) DocBase
Append appends DocBase part of an office document to another DocBase.
func (d *DocBase) CreateCustomProperties()
CreateCustomProperties creates the custom properties of the document.
func (d *DocBase) GetImageBytesByTarget(target string) (Image, error)
GetImageBytesByTarget returns Image object with Data bytes read from its target.
func (d *DocBase) GetOrCreateCustomProperties() CustomProperties
GetOrCreateCustomProperties returns the custom properties of the document (and if they not exist yet, creating them first).
func (d *DocBase) WriteExtraFiles(z *zip.Writer) error
WriteExtraFiles writes the extra files to the zip package.
ExtraFile is an unsupported file type extracted from, or to be written to a zip package
type ExtraFile struct {
ZipPath string
DiskPath string // TODO: Change to "StoragePath" in next major version (v2).
}
Hyperlink is just an appropriately configured relationship.
type Hyperlink Relationship
Image is a container for image information. It's used as we need format and and size information to use images. It contains either the filesystem path to the image, or the image itself.
type Image struct {
Size image.Point
Format string
Path string
Data *[]byte
}
func ImageFromBytes(data []byte) (Image, error)
ImageFromBytes returns an Image struct for an in-memory image. You can also construct an Image directly if the file and size are known.
func ImageFromFile(path string) (Image, error)
ImageFromFile reads an image from a file on disk. It doesn't keep the image in memory and only reads it to determine the format and size. You can also construct an Image directly if the file and size are known. NOTE: See also ImageFromStorage.
func ImageFromStorage(path string) (Image, error)
ImageFromStorage reads an image using the currently set temporary storage mechanism (see tempstorage). You can also construct an Image directly if the file and size are known.
ImageRef is a reference to an image within a document.
type ImageRef struct {
// contains filtered or unexported fields
}
func MakeImageRef(img Image, d *DocBase, rels Relationships) ImageRef
MakeImageRef constructs an image reference which is a reference to a particular image file inside a document. The same image can be used multiple times in a document by re-use the ImageRef.
func (i ImageRef) Data() *[]byte
Data returns the data of an image file, if any.
func (i ImageRef) Format() string
Format returns the format of the underlying image
func (i ImageRef) Path() string
Path returns the path to an image file, if any.
func (i ImageRef) RelID() string
RelID returns the relationship ID.
func (i ImageRef) RelativeHeight(w measurement.Distance) measurement.Distance
RelativeHeight returns the relative height of an image given a fixed width. This is used when setting image to a fixed width to calculate the height required to keep the same image aspect ratio.
func (i ImageRef) RelativeWidth(h measurement.Distance) measurement.Distance
RelativeWidth returns the relative width of an image given a fixed height. This is used when setting image to a fixed height to calculate the width required to keep the same image aspect ratio.
func (i *ImageRef) SetRelID(id string)
func (i *ImageRef) SetTarget(target string)
SetTarget changes the target attribute of the image reference (e.g. in the case of the creation of the reference or if the image which the reference is related to was moved from one location to another).
func (i ImageRef) Size() image.Point
Size returns the size of an image
func (i *ImageRef) Target() string
Target returns the target attrubute of the image reference (a path where the image file is located in the document structure).
Relationship is a relationship within a .rels file.
type Relationship struct {
// contains filtered or unexported fields
}
func NewRelationship() Relationship
NewRelationship constructs a new relationship.
func (r Relationship) ID() string
ID returns the ID of a relationship.
func (r Relationship) SetID(ID string)
SetID set the ID of a relationship.
func (r Relationship) SetTarget(s string)
SetTarget set the target (path) of a relationship.
func (r Relationship) String() string
func (r Relationship) Target() string
Target returns the target (path) of a relationship.
func (r Relationship) Type() string
Type returns the type of a relationship.
func (r Relationship) X() *relationships.Relationship
X returns the inner wrapped XML type.
Relationships represents a .rels file.
type Relationships struct {
// contains filtered or unexported fields
}
func NewRelationships() Relationships
NewRelationships creates a new relationship wrapper.
func NewRelationshipsCopy(rels Relationships) Relationships
NewRelationshipsCopy creates a new relationships wrapper as a copy of passed in instance.
func (r Relationships) AddAutoRelationship(dt unioffice.DocType, src string, idx int, ctype string) Relationship
AddAutoRelationship adds a relationship with an automatically generated filename based off of the type. It should be preferred over AddRelationship to ensure consistent filenames are maintained.
func (r Relationships) AddHyperlink(target string) Hyperlink
AddHyperlink adds an external hyperlink relationship.
func (r Relationships) AddRelationship(target, ctype string) Relationship
AddRelationship adds a relationship.
func (r Relationships) Clear()
Clear removes any existing relationships.
func (r Relationships) CopyRelationship(idAttr string) (Relationship, bool)
CopyRelationship copies the relationship.
func (r Relationships) FindRIDForN(i int, t string) string
FindRIDForN returns the relationship ID for the i'th relationship of type t.
func (r Relationships) GetByRelId(idAttr string) Relationship
GetByRelId returns a relationship with the associated relation ID.
func (r Relationships) GetTargetByRelId(idAttr string) string
GetTargetByRelId returns a target path with the associated relation ID.
func (r Relationships) GetTargetByRelIdAndType(idAttr string, typeAttr string) string
GetTargetByRelIdAndType returns a target path with the associated relation ID.
func (r Relationships) IsEmpty() bool
IsEmpty returns true if there are no relationships.
func (r Relationships) Relationships() []Relationship
Relationships returns a slice of all of the relationships.
func (r Relationships) Remove(rel Relationship) bool
Remove removes an existing relationship.
func (r Relationships) X() *relationships.Relationships
X returns the underlying raw XML data.
Table represents a table in the document.
type Table struct {
// contains filtered or unexported fields
}
func NewTable() *Table
NewTable makes a new table.
func NewTableWithXfrm(xfrm *dml.CT_Transform2D) *Table
NewTableWithXfrm makes a new table with a pointer to its parent Xfrm for changing its offset and size.
func (t Table) AddCol() *TableCol
AddCol adds a column to a table.
func (t Table) AddRow() *TableRow
AddRow adds a row to a table.
func (t Table) Grid() *dml.CT_TableGrid
Properties returns table properties.
func (t Table) Properties() *dml.CT_TableProperties
Properties returns table properties.
func (t Table) Rows() []*TableRow
Rows returns all table rows.
func (t Table) SetOffsetX(offX float64)
SetOffsetX sets horizontal offset of a table in distance units (see measurement package).
func (t Table) SetOffsetY(offY float64)
SetOffsetY sets vertical offset of a table in distance units (see measurement package).
func (t Table) SetStyle(style *dml.CT_TableStyle)
SetStyle assigns TableStyle to a table.
func (t Table) X() *dml.Tbl
X returns the inner wrapped XML type.
TableCol represents a column in a table.
type TableCol struct {
// contains filtered or unexported fields
}
func (c TableCol) SetWidth(m measurement.Distance)
SetWidth sets column width, see measurement package.
TableRow represents a row in a table.
type TableRow struct {
// contains filtered or unexported fields
}
func (r TableRow) Cells() []*dml.CT_TableCell
Cells returns an array of row cells.
func (r TableRow) SetHeight(m measurement.Distance)
SetHeight sets row height, see measurement package.
TableStyles contains document specific properties.
type TableStyles struct {
// contains filtered or unexported fields
}
func NewTableStyles() TableStyles
NewTableStyles constructs a new TableStyles.
func (t TableStyles) DefAttr() string
DefAttr returns the DefAttr property.
func (t TableStyles) TblStyle() []*dml.CT_TableStyle
TblStyle returns the TblStyle property.
func (t TableStyles) X() *dml.TblStyleLst
X returns the inner wrapped XML type.
Theme is a drawingml theme.
type Theme struct {
// contains filtered or unexported fields
}
func NewTheme() Theme
NewTheme constructs a new theme.
func (t Theme) X() *dml.Theme
X returns the inner wrapped XML type.
| Name | Synopsis |
|---|---|
| .. | |
| axcontrol | |
| license | Package license helps manage commercial licenses and check if they are valid for the version of UniOffice used. |
| logger | |
| tempstorage | |
| diskstore | Package diskstore implements tempStorage interface by using disk as a storage |
| memstore | Package memstore implements tempStorage interface by using memory as a storage |