DocumentProperty class

DocumentProperty class

Represents a custom or built-in document property. To learn more, visit the Work with Document Properties documentation article.

Properties

NameDescription
isLinkToContentShows whether this property is linked to content or not.
linkSourceGets the source of a linked custom document property.
nameReturns the name of the property.
typeGets the data type of the property.

Methods

NameDescription
toBool()Returns the property value as bool.
toByteArray()Returns the property value as byte array.
toDateTime()Returns the property value as DateTime in UTC.
toDouble()Returns the property value as double.
toInt()Returns the property value as integer.

Examples

Shows how to work with built-in document properties.

let doc = new aw.Document(base.myDir + "Properties.docx");

// The "Document" object contains some of its metadata in its members.
//console.log(`Document filename:\n\t \"${doc.originalFileName}\"`);

// The document also stores metadata in its built-in properties.
// Each built-in property is a member of the document's "BuiltInDocumentProperties" object.
/*console.log("Built-in Properties:");
for (let docProperty of doc.builtInDocumentProperties)
{
  console.log(docProperty.name);
  console.log(`\tType:\t${docProperty.type}`);
  console.log(`\tValue:\t\"${docProperty.toString()}\"`);
}*/

See Also

CustomDocumentProperties class DocumentPropertyCollection class