Word Get Property
Word Get Property
Section titled “Word Get Property”Type: word-get-property · Package: Word Activities v1.0.4 · Output: object
Reads a metadata field (property) of the document: its title, author, subject, creation or modification dates, etc. Useful to classify or audit documents by their information.
How it works
Section titled “How it works”Returns the value of the property set in property, read from the file’s core properties (the ones in File › Info in Word). It accepts session or path — see the two modes; with path it opens the file, reads it and closes it without changes.
property is picked from the list; it does not accept expressions.
Required parameters
Section titled “Required parameters”| Parameter | Type | Default | Description |
|---|---|---|---|
property | string | — | Property to read: Title · Author · Subject · Description · Keywords · Category · Created · Modified. |
Optional parameters
Section titled “Optional parameters”| Parameter | Type | Default | Description |
|---|---|---|---|
session | ZoanWordSession | — | Session from Word Open (instead of path). Inherited automatically inside a body. |
path | string | — | Path to the .docx (quick mode). Only used when there is no session. |
Output
Section titled “Output”Returns an object:
Title,Author,Subject,Description,Keywords,Category: the property text.Created,Modified: the date as ISO 8601 text (for example2026-03-14T09:30:00.0000000Z). Convert it with the date functions if you need to calculate with it.- If the property has no value:
null. Usestr(value)to treat it as empty text.
Example
Section titled “Example”Word Get Property path = filePath property = Author → output: authorLog message = "Document created by: " + str(author)Common errors
Section titled “Common errors”| Message | Cause and fix |
|---|---|
'session' or 'path' is required. | There is no session and no path. |
File not found. | The path does not exist on the robot’s machine. |
'property' is required. | No property was chosen. |
Related activities
Section titled “Related activities”- Word Set Property — set a property.
- Word Read Text — read the content.