Skip to content

word document get

goworm edited this page Jun 26, 2026 · 52 revisions

Word: Document - get

Returned attributes when getting the document root.

Path: /

Returned Attributes

Key Type Description
title string Document title
author string Author
subject string Subject
keywords string Keywords
description string Description
category string Category
lastModifiedBy string Last modifier
revision string Revision number
created string Created timestamp (ISO 8601)
modified string Modified timestamp (ISO 8601)
pageWidth integer Page width (twips)
pageHeight integer Page height (twips)
orientation string portrait or landscape
marginTop integer Top margin (twips)
marginBottom integer Bottom margin (twips)
marginLeft integer Left margin (twips)
marginRight integer Right margin (twips)
protectionEnforced bool Whether document protection is enforced (true/false)
columns.equalWidth bool Document-default columns equal-width flag (body sectPr cols @equalWidth)
columns.separator bool Document-default columns separator flag (body sectPr cols @sep)
theme.name string Theme display name (a:theme/@name)
theme.colorScheme string Color scheme name (a:clrScheme/@name)
theme.fontScheme string Font scheme name (a:fontScheme/@name)
theme.formatScheme string Format scheme name (a:fmtScheme/@name)
extended.application string docProps/app.xml application identifier (e.g. Microsoft Word)
extended.applicationVersion string docProps/app.xml AppVersion field
extended.pages integer docProps/app.xml Pages count
extended.words integer docProps/app.xml Words count
extended.characters integer docProps/app.xml Characters count
extended.lines integer docProps/app.xml Lines count
extended.paragraphs integer docProps/app.xml Paragraphs count
extended.totalTime integer docProps/app.xml TotalTime field (minutes)

Example

officecli get report.docx /
/ (Document) (15 children)
  title: Annual Report
  author: Finance Team
  pageWidth: 12240
  pageHeight: 15840
  orientation: portrait
  marginTop: 1440

Based on OfficeCLI v1.0.64

Clone this wiki locally