BuiltInDocumentProperties class
BuiltInDocumentProperties class
A collection of built-in document properties. To learn more, visit the Work with Document Properties documentation article.
Remarks
Provides access to DocumentProperty objects by their names (using an indexer) and via a set of typed properties that return values of appropriate types.
The names of the properties are case-insensitive.
The properties in the collection are sorted alphabetically by name.
Inheritance: BuiltInDocumentProperties → DocumentPropertyCollection
Properties
| Name | Description |
|---|---|
| author | Gets or sets the name of the document’s author. |
| bytes | Represents an estimate of the number of bytes in the document. |
| category | Gets or sets the category of the document. |
| characters | Represents an estimate of the number of characters in the document. |
| charactersWithSpaces | Represents an estimate of the number of characters (including spaces) in the document. |
| comments | Gets or sets the document comments. |
| company | Gets or sets the company property. |
| contentStatus | Gets or sets the content status of the document. |
| contentType | Gets or sets the content type of the document. |
| count | Gets number of items in the collection. (Inherited from DocumentPropertyCollection) |
| createdTime | Gets or sets date of the document creation in UTC. |
| hyperlinkBase | Specifies the base string used for evaluating relative hyperlinks in this document. |
| hyperlinksChanged | Indicates whether hyperlinks in a document were changed. |
| keywords | Gets or sets the document keywords. |
| lastPrinted | Gets or sets the date when the document was last printed in UTC. |
| lastSavedBy | Gets or sets the name of the last author. |
| lastSavedTime | Gets or sets the time of the last save in UTC. |
| lines | Represents an estimate of the number of lines in the document. |
| linksUpToDate | Indicates whether hyperlinks in a document are up-to-date. |
| manager | Gets or sets the manager property. |
| nameOfApplication | Gets or sets the name of the application. |
| pages | Represents an estimate of the number of pages in the document. |
| paragraphs | Represents an estimate of the number of paragraphs in the document. |
| revisionNumber | Gets or sets the document revision number. |
| scaleCrop | Indicates whether document thumbnail is cropped or scaled to fit the display. |
| security | Specifies the security level of a document as a numeric value. |
| sharedDocument | Indicates whether the document is a shared document. |
| subject | Gets or sets the subject of the document. |
| template | Gets or sets the informational name of the document template. |
| this[] | (Inherited from DocumentPropertyCollection) |
| this[] | (Inherited from DocumentPropertyCollection) |
| thumbnail | Gets or sets the thumbnail of the document. |
| title | Gets or sets the title of the document. |
| titlesOfParts | Each string in the array specifies the name of a part in the document. |
| totalEditingTime | Gets or sets the total editing time in minutes. |
| version | Represents the version number of the application that created the document. |
| words | Represents an estimate of the number of words in the document. |
Methods
| Name | Description |
|---|---|
| clear() | Removes all properties from the collection. (Inherited from DocumentPropertyCollection) |
| contains(name) | Returns true if a property with the specified name exists in the collection.(Inherited from DocumentPropertyCollection) |
| indexOf(name) | Gets the index of a property by name. (Inherited from DocumentPropertyCollection) |
| remove(name) | Removes a property with the specified name from the collection. (Inherited from DocumentPropertyCollection) |
| removeAt(index) | Removes a property at the specified index. (Inherited from DocumentPropertyCollection) |
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
- module Aspose.Words.Properties
- class DocumentPropertyCollection
- class Document
- property Document.builtInDocumentProperties
- property Document.customDocumentProperties