GetDocumentProperty - Maple Help

Home : Support : Online Help : Programming : Document Tools : GetDocumentProperty

DocumentTools

 GetDocumentProperty
 query property/properties of a document

 Calling Sequence GetDocumentProperty(attr) GetDocumentProperty(attr,mwfile)

Parameters

 attr - name or all ; property of the document that is to be queried mwfile - string ; (optional) filename of a .mw file

Description

 • The GetDocumentProperty function queries a document for the value of a document property.
 • If the option all is specified, all of the document properties are returned.
 • If the second optional argument is provided, then the specified document properties are fetched from given mwfile on disk.

Examples

 > $\mathrm{with}\left(\mathrm{DocumentTools}\right):$

To return all of the document properties of the current worksheet, the option all can be used:

 > $\mathrm{GetDocumentProperty}\left('\mathrm{all}'\right)$
 ${"Active"}{=}{"false"}{,}{"Keywords"}{=}{""}{,}{"Item List"}{=}{"true"}{,}{"Keyword"}{=}{"Tools,Get,query property/properties of a document,Document,Property"}{,}{"Alias"}{=}{""}{,}{"Title"}{=}{""}{,}{"Author"}{=}{""}{,}{"Topic"}{=}{"DocumentTools\left[GetDocumentProperty\right]"}{,}{"Subject"}{=}{""}$ (1)

Suppose that your document has an Author property. To retrieve the value of this property, you can do this:

 > $\mathrm{GetDocumentProperty}\left('\mathrm{Author}'\right)$
 ${""}$ (2)
 > 

Compatibility

 • The DocumentTools[GetDocumentProperty] command was updated in Maple 2017.
 • The mwfile parameter was introduced in Maple 2017.