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

ConstructorDescription
constructor(DocumentPropertyCollection)Constructs from a parent object convertible to this.

Properties

PropertyTypeDescription
languagestringGets or sets the document’s language.
authorstringGets or sets the name of the document’s author.
commentsstringGets or sets the document comments.
categorystringGets or sets the category of the document.
contentTypestringGets or sets the content type of the document.
contentStatusstringGets or sets the content status of the document.
companystringGets or sets the company property.
hyperlinkBasestringGets or sets the hyperlinkbase property.
createdTimeDateGets or sets date of the document creation in local timezone.
createdUniversalTimeDateGets or sets the Universal time of the document creation.
keywordsstringGets or sets the document keywords.
lastPrintedDateGets or sets the date when the document was last printed in local timezone.
lastPrintedUniversalTimeDateGets or sets the Universal time when the document was last printed.
lastSavedBystringGets or sets the name of the last author.
lastSavedTimeDateGets or sets the time of the last save in local timezone.
lastSavedUniversalTimeDateGets or sets the universal time of the last save.
managerstringGets or sets the manager property.
nameOfApplicationstringGets or sets the name of the application.
pagesnumberRepresents an estimate of the number of pages in the document.
revisionNumberstringGets or sets the document revision number.
subjectstringGets or sets the subject of the document.
templatestringGets or sets the informational name of the document template.
titlestringGets or sets the title of the document.
totalEditingTimenumberGets or sets the total editing time in minutes.
versionstringRepresents the version number of the application that created the document.
documentVersionstringRepresents the version of the file.
scaleCropbooleanIndicates the display mode of the document thumbnail.
linksUpToDatebooleanIndicates whether hyperlinks in a document are up-to-date.
wordsnumberRepresents an estimate of the number of words in the document.

Methods

MethodDescription
get(number)Returns a DocumentProperty object by index.
getLanguage()@deprecated. Please use the ’language’ property instead. Gets or sets the document’s language.
setLanguage(string)@deprecated. Please use the ’language’ property instead. Gets or sets the document’s language.
getAuthor()@deprecated. Please use the ‘author’ property instead. Gets or sets the name of the document’s author.
setAuthor(string)@deprecated. Please use the ‘author’ property instead. Gets or sets the name of the document’s author.
getComments()@deprecated. Please use the ‘comments’ property instead. Gets or sets the document comments.
setComments(string)@deprecated. Please use the ‘comments’ property instead. Gets or sets the document comments.
getCategory()@deprecated. Please use the ‘category’ property instead. Gets or sets the category of the document.
setCategory(string)@deprecated. Please use the ‘category’ property instead. Gets or sets the category of the document.
getContentType()@deprecated. Please use the ‘contentType’ property instead. Gets or sets the content type of the document.
setContentType(string)@deprecated. Please use the ‘contentType’ property instead. Gets or sets the content type of the document.
getContentStatus()@deprecated. Please use the ‘contentStatus’ property instead. Gets or sets the content status of the document.
setContentStatus(string)@deprecated. Please use the ‘contentStatus’ property instead. Gets or sets the content status of the document.
getCompany()@deprecated. Please use the ‘company’ property instead. Gets or sets the company property.
setCompany(string)@deprecated. Please use the ‘company’ property instead. Gets or sets the company property.
getHyperlinkBase()@deprecated. Please use the ‘hyperlinkBase’ property instead. Gets or sets the hyperlinkbase property.
setHyperlinkBase(string)@deprecated. Please use the ‘hyperlinkBase’ property instead. Gets or sets the hyperlinkbase property.
getCreatedTime()@deprecated. Please use the ‘createdTime’ property instead. Gets or sets date of the document creation in local timezone.
setCreatedTime(Date)@deprecated. Please use the ‘createdTime’ property instead. Gets or sets date of the document creation in local timezone.
getCreatedUniversalTime()@deprecated. Please use the ‘createdUniversalTime’ property instead. Gets or sets the Universal time of the document creation.
setCreatedUniversalTime(Date)@deprecated. Please use the ‘createdUniversalTime’ property instead. Gets or sets the Universal time of the document creation.
getKeywords()@deprecated. Please use the ‘keywords’ property instead. Gets or sets the document keywords.
setKeywords(string)@deprecated. Please use the ‘keywords’ property instead. Gets or sets the document keywords.
getLastPrinted()@deprecated. Please use the ’lastPrinted’ property instead. Gets or sets the date when the document was last printed in local timezone.
setLastPrinted(Date)@deprecated. Please use the ’lastPrinted’ property instead. Gets or sets the date when the document was last printed in local timezone.
getLastPrintedUniversalTime()@deprecated. Please use the ’lastPrintedUniversalTime’ property instead. Gets or sets the Universal time when the document was last printed.
setLastPrintedUniversalTime(Date)@deprecated. Please use the ’lastPrintedUniversalTime’ property instead. Gets or sets the Universal time when the document was last printed.
getLastSavedBy()@deprecated. Please use the ’lastSavedBy’ property instead. Gets or sets the name of the last author.
setLastSavedBy(string)@deprecated. Please use the ’lastSavedBy’ property instead. Gets or sets the name of the last author.
getLastSavedTime()@deprecated. Please use the ’lastSavedTime’ property instead. Gets or sets the time of the last save in local timezone.
setLastSavedTime(Date)@deprecated. Please use the ’lastSavedTime’ property instead. Gets or sets the time of the last save in local timezone.
getLastSavedUniversalTime()@deprecated. Please use the ’lastSavedUniversalTime’ property instead. Gets or sets the universal time of the last save.
setLastSavedUniversalTime(Date)@deprecated. Please use the ’lastSavedUniversalTime’ property instead. Gets or sets the universal time of the last save.
getManager()@deprecated. Please use the ‘manager’ property instead. Gets or sets the manager property.
setManager(string)@deprecated. Please use the ‘manager’ property instead. Gets or sets the manager property.
getNameOfApplication()@deprecated. Please use the ’nameOfApplication’ property instead. Gets or sets the name of the application.
setNameOfApplication(string)@deprecated. Please use the ’nameOfApplication’ property instead. Gets or sets the name of the application.
getPages()@deprecated. Please use the ‘pages’ property instead. Represents an estimate of the number of pages in the document.
setPages(number)@deprecated. Please use the ‘pages’ property instead. Represents an estimate of the number of pages in the document.
getRevisionNumber()@deprecated. Please use the ‘revisionNumber’ property instead. Gets or sets the document revision number.
setRevisionNumber(string)@deprecated. Please use the ‘revisionNumber’ property instead. Gets or sets the document revision number.
getSubject()@deprecated. Please use the ‘subject’ property instead. Gets or sets the subject of the document.
setSubject(string)@deprecated. Please use the ‘subject’ property instead. Gets or sets the subject of the document.
getTemplate()@deprecated. Please use the ’template’ property instead. Gets or sets the informational name of the document template.
setTemplate(string)@deprecated. Please use the ’template’ property instead. Gets or sets the informational name of the document template.
getTitle()@deprecated. Please use the ’title’ property instead. Gets or sets the title of the document.
setTitle(string)@deprecated. Please use the ’title’ property instead. Gets or sets the title of the document.
getTotalEditingTime()@deprecated. Please use the ’totalEditingTime’ property instead. Gets or sets the total editing time in minutes.
setTotalEditingTime(number)@deprecated. Please use the ’totalEditingTime’ property instead. Gets or sets the total editing time in minutes.
getVersion()@deprecated. Please use the ‘version’ property instead. Represents the version number of the application that created the document.
setVersion(string)@deprecated. Please use the ‘version’ property instead. Represents the version number of the application that created the document.
getDocumentVersion()@deprecated. Please use the ‘documentVersion’ property instead. Represents the version of the file.
setDocumentVersion(string)@deprecated. Please use the ‘documentVersion’ property instead. Represents the version of the file.
getScaleCrop()@deprecated. Please use the ‘scaleCrop’ property instead. Indicates the display mode of the document thumbnail.
setScaleCrop(boolean)@deprecated. Please use the ‘scaleCrop’ property instead. Indicates the display mode of the document thumbnail.
getLinksUpToDate()@deprecated. Please use the ’linksUpToDate’ property instead. Indicates whether hyperlinks in a document are up-to-date.
setLinksUpToDate(boolean)@deprecated. Please use the ’linksUpToDate’ property instead. Indicates whether hyperlinks in a document are up-to-date.
getWords()@deprecated. Please use the ‘words’ property instead. Represents an estimate of the number of words in the document.
setWords(number)@deprecated. Please use the ‘words’ property instead. Represents an estimate of the number of words in the document.
getCount()@deprecated. Please use the ‘count’ property instead. 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.
get(string)Returns a DocumentProperty object by the name of the property.

constructor(DocumentPropertyCollection)

Constructs from a parent object convertible to this.

constructor(obj: DocumentPropertyCollection);

Parameters:

ParameterTypeDescription
objDocumentPropertyCollectionThe parent object.

language

Gets or sets the document’s language.

language : string;

author

Gets or sets the name of the document’s author.

author : string;

comments

Gets or sets the document comments.

comments : string;

category

Gets or sets the category of the document.

category : string;

contentType

Gets or sets the content type of the document.

contentType : string;

contentStatus

Gets or sets the content status of the document.

contentStatus : string;

company

Gets or sets the company property.

company : string;

hyperlinkBase

Gets or sets the hyperlinkbase property.

hyperlinkBase : string;

createdTime

Gets or sets date of the document creation in local timezone.

createdTime : Date;

Remarks

Aspose.Cells does not update this property when you modify the document.

createdUniversalTime

Gets or sets the Universal time of the document creation.

createdUniversalTime : Date;

Remarks

Aspose.Cells does not update this property when you modify the document.

keywords

Gets or sets the document keywords.

keywords : string;

lastPrinted

Gets or sets the date when the document was last printed in local timezone.

lastPrinted : 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.

lastPrintedUniversalTime

Gets or sets the Universal time when the document was last printed.

lastPrintedUniversalTime : Date;

lastSavedBy

Gets or sets the name of the last author.

lastSavedBy : string;

Remarks

Aspose.Cells does not update this property when you modify the document.

lastSavedTime

Gets or sets the time of the last save in local timezone.

lastSavedTime : Date;

Remarks

Aspose.Cells does not update this property when you modify the document.

lastSavedUniversalTime

Gets or sets the universal time of the last save.

lastSavedUniversalTime : Date;

Remarks

Aspose.Cells does not update this property when you modify the document.

manager

Gets or sets the manager property.

manager : string;

nameOfApplication

Gets or sets the name of the application.

nameOfApplication : string;

pages

Represents an estimate of the number of pages in the document.

pages : number;

revisionNumber

Gets or sets the document revision number.

revisionNumber : string;

Remarks

Aspose.Cells does not update this property when you modify the document.

subject

Gets or sets the subject of the document.

subject : string;

template

Gets or sets the informational name of the document template.

template : string;

title

Gets or sets the title of the document.

title : string;

totalEditingTime

Gets or sets the total editing time in minutes.

totalEditingTime : number;

version

Represents the version number of the application that created the document.

version : string;

Remarks

It’s format is “00.0000”,for example : 12.0000

documentVersion

Represents the version of the file.

documentVersion : string;

scaleCrop

Indicates the display mode of the document thumbnail.

scaleCrop : boolean;

linksUpToDate

Indicates whether hyperlinks in a document are up-to-date.

linksUpToDate : boolean;

words

Represents an estimate of the number of words in the document.

words : number;

get(number)

Returns a DocumentProperty object by index.

get(index: number) : DocumentProperty;

Parameters:

ParameterTypeDescription
indexnumberZero-based index of the DocumentProperty to retrieve.

Returns

DocumentProperty

getLanguage()

@deprecated. Please use the ’language’ property instead. Gets or sets the document’s language.

getLanguage() : string;

setLanguage(string)

@deprecated. Please use the ’language’ property instead. Gets or sets the document’s language.

setLanguage(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getAuthor()

@deprecated. Please use the ‘author’ property instead. Gets or sets the name of the document’s author.

getAuthor() : string;

setAuthor(string)

@deprecated. Please use the ‘author’ property instead. Gets or sets the name of the document’s author.

setAuthor(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getComments()

@deprecated. Please use the ‘comments’ property instead. Gets or sets the document comments.

getComments() : string;

setComments(string)

@deprecated. Please use the ‘comments’ property instead. Gets or sets the document comments.

setComments(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getCategory()

@deprecated. Please use the ‘category’ property instead. Gets or sets the category of the document.

getCategory() : string;

setCategory(string)

@deprecated. Please use the ‘category’ property instead. Gets or sets the category of the document.

setCategory(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getContentType()

@deprecated. Please use the ‘contentType’ property instead. Gets or sets the content type of the document.

getContentType() : string;

setContentType(string)

@deprecated. Please use the ‘contentType’ property instead. Gets or sets the content type of the document.

setContentType(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getContentStatus()

@deprecated. Please use the ‘contentStatus’ property instead. Gets or sets the content status of the document.

getContentStatus() : string;

setContentStatus(string)

@deprecated. Please use the ‘contentStatus’ property instead. Gets or sets the content status of the document.

setContentStatus(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getCompany()

@deprecated. Please use the ‘company’ property instead. Gets or sets the company property.

getCompany() : string;

setCompany(string)

@deprecated. Please use the ‘company’ property instead. Gets or sets the company property.

setCompany(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getHyperlinkBase()

@deprecated. Please use the ‘hyperlinkBase’ property instead. Gets or sets the hyperlinkbase property.

getHyperlinkBase() : string;

setHyperlinkBase(string)

@deprecated. Please use the ‘hyperlinkBase’ property instead. Gets or sets the hyperlinkbase property.

setHyperlinkBase(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getCreatedTime()

@deprecated. Please use the ‘createdTime’ property instead. 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)

@deprecated. Please use the ‘createdTime’ property instead. Gets or sets date of the document creation in local timezone.

setCreatedTime(value: Date) : void;

Parameters:

ParameterTypeDescription
valueDateThe value to set.

Remarks

Aspose.Cells does not update this property when you modify the document.

getCreatedUniversalTime()

@deprecated. Please use the ‘createdUniversalTime’ property instead. 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)

@deprecated. Please use the ‘createdUniversalTime’ property instead. Gets or sets the Universal time of the document creation.

setCreatedUniversalTime(value: Date) : void;

Parameters:

ParameterTypeDescription
valueDateThe value to set.

Remarks

Aspose.Cells does not update this property when you modify the document.

getKeywords()

@deprecated. Please use the ‘keywords’ property instead. Gets or sets the document keywords.

getKeywords() : string;

setKeywords(string)

@deprecated. Please use the ‘keywords’ property instead. Gets or sets the document keywords.

setKeywords(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getLastPrinted()

@deprecated. Please use the ’lastPrinted’ property instead. 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)

@deprecated. Please use the ’lastPrinted’ property instead. Gets or sets the date when the document was last printed in local timezone.

setLastPrinted(value: Date) : void;

Parameters:

ParameterTypeDescription
valueDateThe 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()

@deprecated. Please use the ’lastPrintedUniversalTime’ property instead. Gets or sets the Universal time when the document was last printed.

getLastPrintedUniversalTime() : Date;

setLastPrintedUniversalTime(Date)

@deprecated. Please use the ’lastPrintedUniversalTime’ property instead. Gets or sets the Universal time when the document was last printed.

setLastPrintedUniversalTime(value: Date) : void;

Parameters:

ParameterTypeDescription
valueDateThe value to set.

getLastSavedBy()

@deprecated. Please use the ’lastSavedBy’ property instead. 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)

@deprecated. Please use the ’lastSavedBy’ property instead. Gets or sets the name of the last author.

setLastSavedBy(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

Remarks

Aspose.Cells does not update this property when you modify the document.

getLastSavedTime()

@deprecated. Please use the ’lastSavedTime’ property instead. 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)

@deprecated. Please use the ’lastSavedTime’ property instead. Gets or sets the time of the last save in local timezone.

setLastSavedTime(value: Date) : void;

Parameters:

ParameterTypeDescription
valueDateThe value to set.

Remarks

Aspose.Cells does not update this property when you modify the document.

getLastSavedUniversalTime()

@deprecated. Please use the ’lastSavedUniversalTime’ property instead. 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)

@deprecated. Please use the ’lastSavedUniversalTime’ property instead. Gets or sets the universal time of the last save.

setLastSavedUniversalTime(value: Date) : void;

Parameters:

ParameterTypeDescription
valueDateThe value to set.

Remarks

Aspose.Cells does not update this property when you modify the document.

getManager()

@deprecated. Please use the ‘manager’ property instead. Gets or sets the manager property.

getManager() : string;

setManager(string)

@deprecated. Please use the ‘manager’ property instead. Gets or sets the manager property.

setManager(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getNameOfApplication()

@deprecated. Please use the ’nameOfApplication’ property instead. Gets or sets the name of the application.

getNameOfApplication() : string;

setNameOfApplication(string)

@deprecated. Please use the ’nameOfApplication’ property instead. Gets or sets the name of the application.

setNameOfApplication(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getPages()

@deprecated. Please use the ‘pages’ property instead. Represents an estimate of the number of pages in the document.

getPages() : number;

setPages(number)

@deprecated. Please use the ‘pages’ property instead. Represents an estimate of the number of pages in the document.

setPages(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getRevisionNumber()

@deprecated. Please use the ‘revisionNumber’ property instead. Gets or sets the document revision number.

getRevisionNumber() : string;

Remarks

Aspose.Cells does not update this property when you modify the document.

setRevisionNumber(string)

@deprecated. Please use the ‘revisionNumber’ property instead. Gets or sets the document revision number.

setRevisionNumber(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

Remarks

Aspose.Cells does not update this property when you modify the document.

getSubject()

@deprecated. Please use the ‘subject’ property instead. Gets or sets the subject of the document.

getSubject() : string;

setSubject(string)

@deprecated. Please use the ‘subject’ property instead. Gets or sets the subject of the document.

setSubject(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getTemplate()

@deprecated. Please use the ’template’ property instead. Gets or sets the informational name of the document template.

getTemplate() : string;

setTemplate(string)

@deprecated. Please use the ’template’ property instead. Gets or sets the informational name of the document template.

setTemplate(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getTitle()

@deprecated. Please use the ’title’ property instead. Gets or sets the title of the document.

getTitle() : string;

setTitle(string)

@deprecated. Please use the ’title’ property instead. Gets or sets the title of the document.

setTitle(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getTotalEditingTime()

@deprecated. Please use the ’totalEditingTime’ property instead. Gets or sets the total editing time in minutes.

getTotalEditingTime() : number;

setTotalEditingTime(number)

@deprecated. Please use the ’totalEditingTime’ property instead. Gets or sets the total editing time in minutes.

setTotalEditingTime(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getVersion()

@deprecated. Please use the ‘version’ property instead. 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)

@deprecated. Please use the ‘version’ property instead. Represents the version number of the application that created the document.

setVersion(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

Remarks

It’s format is “00.0000”,for example : 12.0000

getDocumentVersion()

@deprecated. Please use the ‘documentVersion’ property instead. Represents the version of the file.

getDocumentVersion() : string;

setDocumentVersion(string)

@deprecated. Please use the ‘documentVersion’ property instead. Represents the version of the file.

setDocumentVersion(value: string) : void;

Parameters:

ParameterTypeDescription
valuestringThe value to set.

getScaleCrop()

@deprecated. Please use the ‘scaleCrop’ property instead. Indicates the display mode of the document thumbnail.

getScaleCrop() : boolean;

setScaleCrop(boolean)

@deprecated. Please use the ‘scaleCrop’ property instead. Indicates the display mode of the document thumbnail.

setScaleCrop(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getLinksUpToDate()

@deprecated. Please use the ’linksUpToDate’ property instead. Indicates whether hyperlinks in a document are up-to-date.

getLinksUpToDate() : boolean;

setLinksUpToDate(boolean)

@deprecated. Please use the ’linksUpToDate’ property instead. Indicates whether hyperlinks in a document are up-to-date.

setLinksUpToDate(value: boolean) : void;

Parameters:

ParameterTypeDescription
valuebooleanThe value to set.

getWords()

@deprecated. Please use the ‘words’ property instead. Represents an estimate of the number of words in the document.

getWords() : number;

setWords(number)

@deprecated. Please use the ‘words’ property instead. Represents an estimate of the number of words in the document.

setWords(value: number) : void;

Parameters:

ParameterTypeDescription
valuenumberThe value to set.

getCount()

@deprecated. Please use the ‘count’ property instead. 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:

ParameterTypeDescription
namestringThe 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:

ParameterTypeDescription
namestringThe 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:

ParameterTypeDescription
namestringThe case-insensitive name of the property.

removeAt(number)

Removes a property at the specified index.

removeAt(index: number) : void;

Parameters:

ParameterTypeDescription
indexnumberThe zero based index.

get(string)

Returns a DocumentProperty object by the name of the property.

get(name: string) : DocumentProperty;

Parameters:

ParameterTypeDescription
namestringThe case-insensitive name of the property to retrieve.

Returns

DocumentProperty

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.