com.groupdocs.metadata

Interfaces

Classes

Exceptions

com.groupdocs.metadata

Class DocMetadata

    • Constructor Detail

      • DocMetadata

        public DocMetadata()

        Initializes a new instance of the DocMetadata class.

    • Method Detail

      • getAuthor

        public final String getAuthor()

        Gets document's author.

        Returns:
        The author.
      • setAuthor

        public final void setAuthor(String value)

        Sets document's author.

        Parameters:
        value - The author.
      • getBytesInDocument

        public final Integer getBytesInDocument()

        Gets an estimate of the number of bytes in the document.

        Returns:
        The bytes in document.
      • getCategory

        public final String getCategory()

        Gets category. Could not be updated in ODT.

        Returns:
        The category.
      • setCategory

        public final void setCategory(String value)

        Sets category. Could not be updated in ODT.

        Parameters:
        value - The category.
      • getComments

        public final String getComments()

        Gets comments.

        Returns:
        The comments.
      • setComments

        public final void setComments(String value)

        Sets comments.

        Parameters:
        value - The comments.
      • getCompany

        public final String getCompany()

        Gets company.

        Returns:
        The company.
      • setCompany

        public final void setCompany(String value)

        Sets company.

        Parameters:
        value - The company.
      • getContentStatus

        public final String getContentStatus()

        Gets content status.

        Returns:
        The content status.
      • setContentStatus

        public final void setContentStatus(String value)

        Sets content status.

        Parameters:
        value - The content status.
      • getContentType

        public final String getContentType()

        Gets content type of the document.

        Returns:
        The type of the content.
      • getCreatedTime

        public final Date getCreatedTime()

        Gets document created date.

        Returns:
        The created time.


        Read-only property. Returns DateTime.MinValue if not specified.

      • getHyperlinkBase

        public final String getHyperlinkBase()

        Gets or sets hyperlink base.

      • setHyperlinkBase

        public final void setHyperlinkBase(String value)

        Gets or sets hyperlink base.

      • getKeywords

        public final String getKeywords()

        Gets keywords.

        Returns:
        The keywords.
      • setKeywords

        public final void setKeywords(String value)

        Sets keywords.

        Parameters:
        value - The keywords.
      • getLastPrintedDate

        public final Date getLastPrintedDate()

        Gets last printed date in UTC.


        Read-only property. Returns DateTime.MinValue if not specified.

      • getLastSavedBy

        public final String getLastSavedBy()

        Gets the name of the last author.

        Returns:
        The last saved by.


        Read-only property.

      • getManager

        public final String getManager()

        Gets manager.

        Returns:
        The manager.
      • setManager

        public final void setManager(String value)

        Sets manager.

        Parameters:
        value - The manager.
      • getNameOfApplication

        public final String getNameOfApplication()

        Gets name of application.

        Returns:
        The name of application.
      • getRevisionNumber

        public final int getRevisionNumber()

        Gets revision number.

        Returns:
        The revision number.


        Read-only property.

      • getTitle

        public final String getTitle()

        Gets title of document.

        Returns:
        The title.
      • setTitle

        public final void setTitle(String value)

        Sets title of document.

        Parameters:
        value - The title.
      • getTitlesOfParts

        public final String[] getTitlesOfParts()

        Gets titles of parts. Read-only.

        Returns:
        Titles of parts.
      • getDocumentComments

        public final DocComment[] getDocumentComments()

        Gets array of DocComment presented in Word document.

        Returns:
        The document comments.
      • remove

        public boolean remove(String key)

        Removes existing metadata property by key.

        Overrides:
        remove in class DocumentMetadata<DocMetadataProperty>
        Parameters:
        key - Metadata key.
        Returns:
        Returns true if metadata was found and deleted.
      • add

        public final void add(String key,
               String value)

        Adds metadata with string value.

        Parameters:
        key - Metadata key.
        value - Metadata value.
      • add

        public final void add(String key,
               boolean value)

        Adds metadata with boolean value.

        Parameters:
        key - Metadata key.
        value - Metadata value.
      • add

        public final void add(String key,
               Date value)

        Adds DateTime metadata.

        Parameters:
        key - Metadata key.
        value - Metadata value.
      • add

        public final void add(String key,
               int value)

        Adds metadata with integer value.

        Parameters:
        key - Metadata key.
        value - Metadata value.
      • add

        public final void add(String key,
               double value)

        Adds metadata with double value.

        Parameters:
        key - Metadata key.
        value - Metadata value.
      • isBuiltIn

        public boolean isBuiltIn(String key)

        Determines whether metadata is built-in.

        Overrides:
        isBuiltIn in class DocumentMetadata<DocMetadataProperty>
        Parameters:
        key - Metadata key.
        Returns:
        Returns true if metadata is built-in.
        Throws:
        ArgumentNullException - Key could not be null or empty.
      • isReadOnly

        public boolean isReadOnly(String key)

        Returns true if <b>built-in</b> metadata key is read-only in Word document.

        Overrides:
        isReadOnly in class DocumentMetadata<DocMetadataProperty>
        Parameters:
        key - Metadata key.
        Returns:
        True if metadata key is read-only; otherwise false.