GetDocumentProperty - Maple Help
For the best experience, we recommend viewing online help using Google Chrome or Microsoft Edge.
Our website is currently undergoing maintenance, which may result in occasional errors while browsing. We apologize for any inconvenience this may cause and are working swiftly to restore full functionality. Thank you for your patience.

Online Help

All Products    Maple    MapleSim


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

DocumentTools

  

GetDocumentProperty

  

query property/properties of a document

 

Calling Sequence

Parameters

Description

Examples

Compatibility

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

withDocumentTools:

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

GetDocumentPropertyall

Active=false,Keywords=<default>,Item List=true,Keyword=Get,Document,Property,query property/properties of a document,Tools,Alias=,Title=<default>,Author=<default>,Topic=DocumentTools[GetDocumentProperty],Subject=<default>

(1)

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

GetDocumentPropertyAuthor

<default>

(2)

Compatibility

• 

The DocumentTools[GetDocumentProperty] command was updated in Maple 2017.

• 

The mwfile parameter was introduced in Maple 2017.

• 

For more information on Maple 2017 changes, see Updates in Maple 2017.

See Also

DocumentTools

DocumentTools[SetDocumentProperty]