BuiltInDocumentPropertyCollection
BuiltInDocumentPropertyCollection class
A collection of built-in document properties.
class BuiltInDocumentPropertyCollection extends DocumentPropertyCollection;
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.
Constructors
| Name | Description |
|---|---|
| constructor(DocumentPropertyCollection) | Constructs from a parent object convertible to this. |
Methods
| Method | Description |
|---|---|
| get(string) | Returns a DocumentProperty object by the name of the property. |
| get(number) | Returns a DocumentProperty object by index. |
| getLanguage() | Gets or sets the document’s language. |
| setLanguage(string) | Gets or sets the document’s language. |
| getAuthor() | Gets or sets the name of the document’s author. |
| setAuthor(string) | Gets or sets the name of the document’s author. |
| getComments() | Gets or sets the document comments. |
| setComments(string) | Gets or sets the document comments. |
| getCategory() | Gets or sets the category of the document. |
| setCategory(string) | Gets or sets the category of the document. |
| getContentType() | Gets or sets the content type of the document. |
| setContentType(string) | Gets or sets the content type of the document. |
| getContentStatus() | Gets or sets the content status of the document. |
| setContentStatus(string) | Gets or sets the content status of the document. |
| getCompany() | Gets or sets the company property. |
| setCompany(string) | Gets or sets the company property. |
| getHyperlinkBase() | Gets or sets the hyperlinkbase property. |
| setHyperlinkBase(string) | Gets or sets the hyperlinkbase property. |
| getCreatedTime() | Gets or sets date of the document creation in local timezone. |
| setCreatedTime(Date) | Gets or sets date of the document creation in local timezone. |
| getCreatedUniversalTime() | Gets or sets the Universal time of the document creation. |
| setCreatedUniversalTime(Date) | Gets or sets the Universal time of the document creation. |
| getKeywords() | Gets or sets the document keywords. |
| setKeywords(string) | Gets or sets the document keywords. |
| getLastPrinted() | Gets or sets the date when the document was last printed in local timezone. |
| setLastPrinted(Date) | Gets or sets the date when the document was last printed in local timezone. |
| getLastPrintedUniversalTime() | Gets or sets the Universal time when the document was last printed. |
| setLastPrintedUniversalTime(Date) | Gets or sets the Universal time when the document was last printed. |
| getLastSavedBy() | Gets or sets the name of the last author. |
| setLastSavedBy(string) | Gets or sets the name of the last author. |
| getLastSavedTime() | Gets or sets the time of the last save in local timezone. |
| setLastSavedTime(Date) | Gets or sets the time of the last save in local timezone. |
| getLastSavedUniversalTime() | Gets or sets the universal time of the last save. |
| setLastSavedUniversalTime(Date) | Gets or sets the universal time of the last save. |
| getManager() | Gets or sets the manager property. |
| setManager(string) | Gets or sets the manager property. |
| getNameOfApplication() | Gets or sets the name of the application. |
| setNameOfApplication(string) | Gets or sets the name of the application. |
| getPages() | Represents an estimate of the number of pages in the document. |
| setPages(number) | Represents an estimate of the number of pages in the document. |
| getRevisionNumber() | Gets or sets the document revision number. |
| setRevisionNumber(string) | Gets or sets the document revision number. |
| getSubject() | Gets or sets the subject of the document. |
| setSubject(string) | Gets or sets the subject of the document. |
| getTemplate() | Gets or sets the informational name of the document template. |
| setTemplate(string) | Gets or sets the informational name of the document template. |
| getTitle() | Gets or sets the title of the document. |
| setTitle(string) | Gets or sets the title of the document. |
| getTotalEditingTime() | Gets or sets the total editing time in minutes. |
| setTotalEditingTime(number) | Gets or sets the total editing time in minutes. |
| getVersion() | Represents the version number of the application that created the document. |
| setVersion(string) | Represents the version number of the application that created the document. |
| getDocumentVersion() | Represents the version of the file. |
| setDocumentVersion(string) | Represents the version of the file. |
| getScaleCrop() | Indicates the display mode of the document thumbnail. |
| setScaleCrop(boolean) | Indicates the display mode of the document thumbnail. |
| getLinksUpToDate() | Indicates whether hyperlinks in a document are up-to-date. |
| setLinksUpToDate(boolean) | Indicates whether hyperlinks in a document are up-to-date. |
| getWords() | Represents an estimate of the number of words in the document. |
| setWords(number) | Represents an estimate of the number of words in the document. |
| getCount() | Gets the number of elements contained in. |
| isNull() | Checks whether the implementation object is null. |
| contains(string) | Returns true if a property with the specified name exists in the collection. |
| indexOf(string) | Gets the index of a property by name. |
| remove(string) | Removes a property with the specified name from the collection. |
| removeAt(number) | Removes a property at the specified index. |
constructor(DocumentPropertyCollection)
Constructs from a parent object convertible to this.
constructor(obj: DocumentPropertyCollection);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| obj | DocumentPropertyCollection | The parent object. |
get(string)
Returns a DocumentProperty object by the name of the property.
get(name: string) : DocumentProperty;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| name | string | The case-insensitive name of the property to retrieve. |
Returns
Remarks
The string names of the properties correspond to the names of the typed properties available from BuiltInDocumentPropertyCollection.
If you request a property that is not present in the document, but the name of the property is recognized as a valid built-in name, a new DocumentProperty is created, added to the collection and returned. The newly created property is assigned a default value (empty string, zero, false or DateTime.MinValue depending on the type of the built-in property).
If you request a property that is not present in the document and the name is not recognized as a built-in name, a null is returned.
get(number)
Returns a DocumentProperty object by index.
get(index: number) : DocumentProperty;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number | Zero-based index of the DocumentProperty to retrieve. |
Returns
getLanguage()
Gets or sets the document’s language.
getLanguage() : string;
setLanguage(string)
Gets or sets the document’s language.
setLanguage(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getAuthor()
Gets or sets the name of the document’s author.
getAuthor() : string;
setAuthor(string)
Gets or sets the name of the document’s author.
setAuthor(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getComments()
Gets or sets the document comments.
getComments() : string;
setComments(string)
Gets or sets the document comments.
setComments(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getCategory()
Gets or sets the category of the document.
getCategory() : string;
setCategory(string)
Gets or sets the category of the document.
setCategory(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getContentType()
Gets or sets the content type of the document.
getContentType() : string;
setContentType(string)
Gets or sets the content type of the document.
setContentType(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getContentStatus()
Gets or sets the content status of the document.
getContentStatus() : string;
setContentStatus(string)
Gets or sets the content status of the document.
setContentStatus(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getCompany()
Gets or sets the company property.
getCompany() : string;
setCompany(string)
Gets or sets the company property.
setCompany(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getHyperlinkBase()
Gets or sets the hyperlinkbase property.
getHyperlinkBase() : string;
setHyperlinkBase(string)
Gets or sets the hyperlinkbase property.
setHyperlinkBase(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getCreatedTime()
Gets or sets date of the document creation in local timezone.
getCreatedTime() : Date;
Remarks
Aspose.Cells does not update this property when you modify the document.
setCreatedTime(Date)
Gets or sets date of the document creation in local timezone.
setCreatedTime(value: Date) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Date | The value to set. |
Remarks
Aspose.Cells does not update this property when you modify the document.
getCreatedUniversalTime()
Gets or sets the Universal time of the document creation.
getCreatedUniversalTime() : Date;
Remarks
Aspose.Cells does not update this property when you modify the document.
setCreatedUniversalTime(Date)
Gets or sets the Universal time of the document creation.
setCreatedUniversalTime(value: Date) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Date | The value to set. |
Remarks
Aspose.Cells does not update this property when you modify the document.
getKeywords()
Gets or sets the document keywords.
getKeywords() : string;
setKeywords(string)
Gets or sets the document keywords.
setKeywords(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getLastPrinted()
Gets or sets the date when the document was last printed in local timezone.
getLastPrinted() : Date;
Remarks
If the document was never printed, this property will return DateTime.MinValue.
Aspose.Cells does not update this property when you modify the document.
setLastPrinted(Date)
Gets or sets the date when the document was last printed in local timezone.
setLastPrinted(value: Date) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Date | The value to set. |
Remarks
If the document was never printed, this property will return DateTime.MinValue.
Aspose.Cells does not update this property when you modify the document.
getLastPrintedUniversalTime()
Gets or sets the Universal time when the document was last printed.
getLastPrintedUniversalTime() : Date;
setLastPrintedUniversalTime(Date)
Gets or sets the Universal time when the document was last printed.
setLastPrintedUniversalTime(value: Date) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Date | The value to set. |
getLastSavedBy()
Gets or sets the name of the last author.
getLastSavedBy() : string;
Remarks
Aspose.Cells does not update this property when you modify the document.
setLastSavedBy(string)
Gets or sets the name of the last author.
setLastSavedBy(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
Remarks
Aspose.Cells does not update this property when you modify the document.
getLastSavedTime()
Gets or sets the time of the last save in local timezone.
getLastSavedTime() : Date;
Remarks
Aspose.Cells does not update this property when you modify the document.
setLastSavedTime(Date)
Gets or sets the time of the last save in local timezone.
setLastSavedTime(value: Date) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Date | The value to set. |
Remarks
Aspose.Cells does not update this property when you modify the document.
getLastSavedUniversalTime()
Gets or sets the universal time of the last save.
getLastSavedUniversalTime() : Date;
Remarks
Aspose.Cells does not update this property when you modify the document.
setLastSavedUniversalTime(Date)
Gets or sets the universal time of the last save.
setLastSavedUniversalTime(value: Date) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | Date | The value to set. |
Remarks
Aspose.Cells does not update this property when you modify the document.
getManager()
Gets or sets the manager property.
getManager() : string;
setManager(string)
Gets or sets the manager property.
setManager(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getNameOfApplication()
Gets or sets the name of the application.
getNameOfApplication() : string;
setNameOfApplication(string)
Gets or sets the name of the application.
setNameOfApplication(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getPages()
Represents an estimate of the number of pages in the document.
getPages() : number;
setPages(number)
Represents an estimate of the number of pages in the document.
setPages(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getRevisionNumber()
Gets or sets the document revision number.
getRevisionNumber() : string;
Remarks
Aspose.Cells does not update this property when you modify the document.
setRevisionNumber(string)
Gets or sets the document revision number.
setRevisionNumber(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
Remarks
Aspose.Cells does not update this property when you modify the document.
getSubject()
Gets or sets the subject of the document.
getSubject() : string;
setSubject(string)
Gets or sets the subject of the document.
setSubject(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getTemplate()
Gets or sets the informational name of the document template.
getTemplate() : string;
setTemplate(string)
Gets or sets the informational name of the document template.
setTemplate(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getTitle()
Gets or sets the title of the document.
getTitle() : string;
setTitle(string)
Gets or sets the title of the document.
setTitle(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getTotalEditingTime()
Gets or sets the total editing time in minutes.
getTotalEditingTime() : number;
setTotalEditingTime(number)
Gets or sets the total editing time in minutes.
setTotalEditingTime(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getVersion()
Represents the version number of the application that created the document.
getVersion() : string;
Remarks
It’s format is “00.0000”,for example : 12.0000
setVersion(string)
Represents the version number of the application that created the document.
setVersion(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
Remarks
It’s format is “00.0000”,for example : 12.0000
getDocumentVersion()
Represents the version of the file.
getDocumentVersion() : string;
setDocumentVersion(string)
Represents the version of the file.
setDocumentVersion(value: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | string | The value to set. |
getScaleCrop()
Indicates the display mode of the document thumbnail.
getScaleCrop() : boolean;
setScaleCrop(boolean)
Indicates the display mode of the document thumbnail.
setScaleCrop(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getLinksUpToDate()
Indicates whether hyperlinks in a document are up-to-date.
getLinksUpToDate() : boolean;
setLinksUpToDate(boolean)
Indicates whether hyperlinks in a document are up-to-date.
setLinksUpToDate(value: boolean) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | The value to set. |
getWords()
Represents an estimate of the number of words in the document.
getWords() : number;
setWords(number)
Represents an estimate of the number of words in the document.
setWords(value: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | number | The value to set. |
getCount()
Gets the number of elements contained in.
getCount() : number;
isNull()
Checks whether the implementation object is null.
isNull() : boolean;
contains(string)
Returns true if a property with the specified name exists in the collection.
contains(name: string) : boolean;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| name | string | The case-insensitive name of the property. |
Returns
True if the property exists in the collection; false otherwise.
indexOf(string)
Gets the index of a property by name.
indexOf(name: string) : number;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| name | string | The case-insensitive name of the property. |
Returns
The zero based index. Negative value if not found.
remove(string)
Removes a property with the specified name from the collection.
remove(name: string) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| name | string | The case-insensitive name of the property. |
removeAt(number)
Removes a property at the specified index.
removeAt(index: number) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| index | number | The zero based index. |