DocumentTools - Maple Programming Help

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : Programming : Document Tools : DocumentTools/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

with(DocumentTools):

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

GetDocumentProperty( 'all' );

Active=false,Keywords=<default>,Item List=true,Keyword=Document,Tools,Property,Get,Query property/properties of a document,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:

GetDocumentProperty('Author');

<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]