public final class DocMetadata extends DocumentMetadata<DocMetadataProperty>
Represents metadata in DocumentType.Doc
document.
Constructor and Description |
---|
DocMetadata()
Initializes a new instance of the
DocMetadata class. |
Modifier and Type | Method and Description |
---|---|
void |
add(String key,
boolean value)
Adds metadata with boolean value.
|
void |
add(String key,
Date value)
Adds
DateTime metadata. |
void |
add(String key,
double value)
Adds metadata with double value.
|
void |
add(String key,
int value)
Adds metadata with integer value.
|
void |
add(String key,
String value)
Adds metadata with string value.
|
String |
getAuthor()
Gets or sets document's author.
|
Integer |
getBytesInDocument()
Gets an estimate of the number of bytes in the document.
|
String |
getCategory()
Gets or sets category.
|
String |
getComments()
Gets or sets comments.
|
String |
getCompany()
Gets or sets company.
|
String |
getContentStatus()
Gets or sets content status.
|
String |
getContentType()
Gets content type of the document.
|
Date |
getCreatedTime()
Gets document created date.
|
DocComment[] |
getDocumentComments()
Gets array of
DocComment presented in Word document. |
String |
getHyperlinkBase()
Gets or sets hyperlink base.
|
protected DocMetadataProperty |
getInstance() |
String |
getKeywords()
Gets or sets keywords.
|
Date |
getLastPrintedDate()
Gets last printed date in UTC.
|
String |
getLastSavedBy()
Gets the name of the last author.
|
String |
getManager()
Gets or sets manager.
|
String |
getNameOfApplication()
Gets name of application.
|
int |
getRevisionNumber()
Gets revision number.
|
String |
getTitle()
Gets or sets title of document.
|
String[] |
getTitlesOfParts()
Gets titles of parts.
|
boolean |
isBuiltIn(String key)
Determines whether metadata is built-in.
|
boolean |
isReadOnly(String key)
Returns true if
<b>built-in</b> metadata key is read-only in Word document. |
boolean |
remove(String key)
Removes existing metadata property by key.
|
void |
setAuthor(String value)
Gets or sets document's author.
|
void |
setCategory(String value)
Gets or sets category.
|
void |
setComments(String value)
Gets or sets comments.
|
void |
setCompany(String value)
Gets or sets company.
|
void |
setContentStatus(String value)
Gets or sets content status.
|
void |
setHyperlinkBase(String value)
Gets or sets hyperlink base.
|
void |
setKeywords(String value)
Gets or sets keywords.
|
void |
setManager(String value)
Gets or sets manager.
|
void |
setTitle(String value)
Gets or sets title of document.
|
clear, clearBuiltInData, clearCustomData, containsKey, getCollection, getCount, getKeys, readPropertyValue, setValueByKey
getByType, getMetadataType, readByStringKey
public DocMetadata()
Initializes a new instance of the DocMetadata
class.
public final String getAuthor()
Gets or sets document's author.
Value: The author.public final void setAuthor(String value)
Gets or sets document's author.
Value: The author.public final Integer getBytesInDocument()
Gets an estimate of the number of bytes in the document.
Value: The bytes in document.public final String getCategory()
Gets or sets category. Could not be updated in ODT.
Value: The category.public final void setCategory(String value)
Gets or sets category. Could not be updated in ODT.
Value: The category.public final String getComments()
Gets or sets comments.
Value: The comments.public final void setComments(String value)
Gets or sets comments.
Value: The comments.public final String getCompany()
Gets or sets company.
Value: The company.public final void setCompany(String value)
Gets or sets company.
Value: The company.public final String getContentStatus()
Gets or sets content status.
Value: The content status.public final void setContentStatus(String value)
Gets or sets content status.
Value: The content status.public final String getContentType()
Gets content type of the document.
Value: The type of the content.public final Date getCreatedTime()
Gets document created date.
Value: The created time.DateTime.MinValue
if not specified.
public final String getHyperlinkBase()
Gets or sets hyperlink base.
public final void setHyperlinkBase(String value)
Gets or sets hyperlink base.
public final String getKeywords()
Gets or sets keywords.
Value: The keywords.public final void setKeywords(String value)
Gets or sets keywords.
Value: The keywords.public final Date getLastPrintedDate()
Gets last printed date in UTC.
DateTime.MinValue
if not specified.
public final String getLastSavedBy()
Gets the name of the last author.
Value: The last saved by.public final String getManager()
Gets or sets manager.
Value: The manager.public final void setManager(String value)
Gets or sets manager.
Value: The manager.public final String getNameOfApplication()
Gets name of application.
Value: The name of application.public final int getRevisionNumber()
Gets revision number.
Value: The revision number.public final String getTitle()
Gets or sets title of document.
Value: The title.public final void setTitle(String value)
Gets or sets title of document.
Value: The title.public final String[] getTitlesOfParts()
Gets titles of parts. Read-only.
Value: Titles of parts.public final DocComment[] getDocumentComments()
Gets array of DocComment
presented in Word document.
public boolean remove(String key)
Removes existing metadata property by key.
remove
in class DocumentMetadata<DocMetadataProperty>
key
- Metadata key.public final void add(String key, String value)
Adds metadata with string value.
key
- Metadata key.value
- Metadata value.public final void add(String key, boolean value)
Adds metadata with boolean value.
key
- Metadata key.value
- Metadata value.public final void add(String key, Date value)
Adds DateTime
metadata.
key
- Metadata key.value
- Metadata value.public final void add(String key, int value)
Adds metadata with integer value.
key
- Metadata key.value
- Metadata value.public final void add(String key, double value)
Adds metadata with double value.
key
- Metadata key.value
- Metadata value.public boolean isBuiltIn(String key)
Determines whether metadata is built-in.
isBuiltIn
in class DocumentMetadata<DocMetadataProperty>
key
- Metadata key.ArgumentNullException
- Key could not be null or empty.public boolean isReadOnly(String key)
Returns true if <b>built-in</b>
metadata key is read-only in Word document.
isReadOnly
in class DocumentMetadata<DocMetadataProperty>
key
- Metadata key.protected DocMetadataProperty getInstance()
getInstance
in class DocumentMetadata<DocMetadataProperty>
Copyright © 2017. All rights reserved.