com.aspose.slides

Interfaces

Classes

Exceptions

com.aspose.slides

Interface IDocumentProperties

  • All Known Implementing Classes:
    DocumentProperties


    public interface IDocumentProperties

    Represents properties of a presentation.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method and Description
      void clearBuiltInProperties()
      Clears and sets default values for all builtIn properties.
      void clearCustomProperties()
      Removes all custom properties.
      boolean containsCustomProperty(java.lang.String name)
      Check presents of a custom property with a specified name.
      java.lang.Object get_Item(java.lang.String name)
      Returns or sets the custom property associated with a specified name.
      java.lang.String getApplicationTemplate()
      Returns or sets the template of a application.
      java.lang.String getAppVersion()
      Returns the app version.
      java.lang.String getAuthor()
      Returns or sets the author of a presentation.
      java.lang.String getCategory()
      Returns or sets the category of a presentation.
      java.lang.String getComments()
      Returns or sets the comments of a presentation.
      java.lang.String getCompany()
      Returns or sets the company property.
      java.lang.String getContentStatus()
      Returns or sets the content status of a presentation.
      java.lang.String getContentType()
      Returns or sets the content type of a presentation.
      int getCountOfCustomProperties()
      Returns the number of custom properties actually contained in a collection.
      java.util.Date getCreatedTime()
      Returns the date when a presentation was created.
      java.lang.String getCustomPropertyName(int index)
      Return a custom property name at the specified index.
      void getCustomPropertyValue(java.lang.String name, boolean[] value)
      Gets a named boolean value from the custom properties.
      void getCustomPropertyValue(java.lang.String name, java.util.Date[] value)
      Gets a named DateTime value from the custom properties.
      void getCustomPropertyValue(java.lang.String name, double[] value)
      Gets a named double value from the custom properties.
      void getCustomPropertyValue(java.lang.String name, float[] value)
      Gets a named float value from the custom properties.
      void getCustomPropertyValue(java.lang.String name, int[] value)
      Gets a named integer value from the custom properties.
      void getCustomPropertyValue(java.lang.String name, java.lang.String[] value)
      Gets a named string value from the custom properties.
      java.lang.String getHyperlinkBase()
      Returns or sets the HyperlinkBase document property.
      java.lang.String getKeywords()
      Returns or sets the keywords of a presentation.
      java.util.Date getLastPrinted()
      Returns the date when a presentation was printed last time.
      java.lang.String getLastSavedBy()
      Returns or sets the name of a last person who modified a presentation.
      java.util.Date getLastSavedTime()
      Returns the date when a presentation was modified last time.
      java.lang.String getManager()
      Returns or sets the manager property.
      java.lang.String getNameOfApplication()
      Returns or sets the name of the application.
      java.lang.String getPresentationFormat()
      Returns or sets the intended format of a presentation.
      int getRevisionNumber()
      Returns or sets the presentation revision number.
      boolean getSharedDoc()
      Determines whether the presentation is shared between multiple people.
      java.lang.String getSubject()
      Returns or sets the subject of a presentation.
      java.lang.String getTitle()
      Returns or sets the title of a presentation.
      double getTotalEditingTime()
      Total editing time of a presentation.
      boolean removeCustomProperty(java.lang.String name)
      Remove a custom property associated with a specified name.
      void set_Item(java.lang.String name, java.lang.Object value)
      Returns or sets the custom property associated with a specified name.
      void setApplicationTemplate(java.lang.String value)
      Returns or sets the template of a application.
      void setAuthor(java.lang.String value)
      Returns or sets the author of a presentation.
      void setCategory(java.lang.String value)
      Returns or sets the category of a presentation.
      void setComments(java.lang.String value)
      Returns or sets the comments of a presentation.
      void setCompany(java.lang.String value)
      Returns or sets the company property.
      void setContentStatus(java.lang.String value)
      Returns or sets the content status of a presentation.
      void setContentType(java.lang.String value)
      Returns or sets the content type of a presentation.
      void setCreatedTime(java.util.Date value)
      Returns the date when a presentation was created.
      void setCustomPropertyValue(java.lang.String name, boolean value)
      Sets a named boolean custom property.
      void setCustomPropertyValue(java.lang.String name, java.util.Date value)
      Sets a named DateTime custom property.
      void setCustomPropertyValue(java.lang.String name, double value)
      Sets a named double custom property.
      void setCustomPropertyValue(java.lang.String name, float value)
      Sets a named float custom property.
      void setCustomPropertyValue(java.lang.String name, int value)
      Sets a named integer custom property.
      void setCustomPropertyValue(java.lang.String name, java.lang.String value)
      Sets a named string custom property.
      void setHyperlinkBase(java.lang.String value)
      Returns or sets the HyperlinkBase document property.
      void setKeywords(java.lang.String value)
      Returns or sets the keywords of a presentation.
      void setLastPrinted(java.util.Date value)
      Returns the date when a presentation was printed last time.
      void setLastSavedBy(java.lang.String value)
      Returns or sets the name of a last person who modified a presentation.
      void setLastSavedTime(java.util.Date value)
      Returns the date when a presentation was modified last time.
      void setManager(java.lang.String value)
      Returns or sets the manager property.
      void setNameOfApplication(java.lang.String value)
      Returns or sets the name of the application.
      void setPresentationFormat(java.lang.String value)
      Returns or sets the intended format of a presentation.
      void setRevisionNumber(int value)
      Returns or sets the presentation revision number.
      void setSharedDoc(boolean value)
      Determines whether the presentation is shared between multiple people.
      void setSubject(java.lang.String value)
      Returns or sets the subject of a presentation.
      void setTitle(java.lang.String value)
      Returns or sets the title of a presentation.
      void setTotalEditingTime(double value)
      Total editing time of a presentation.
    • Method Detail

      • getAppVersion

        java.lang.String getAppVersion()

        Returns the app version. Read-only String.

      • getNameOfApplication

        java.lang.String getNameOfApplication()

        Returns or sets the name of the application. Read/write String.

      • setNameOfApplication

        void setNameOfApplication(java.lang.String value)

        Returns or sets the name of the application. Read/write String.

      • getCompany

        java.lang.String getCompany()

        Returns or sets the company property. Read/write String.

      • setCompany

        void setCompany(java.lang.String value)

        Returns or sets the company property. Read/write String.

      • getManager

        java.lang.String getManager()

        Returns or sets the manager property. Read/write String.

      • setManager

        void setManager(java.lang.String value)

        Returns or sets the manager property. Read/write String.

      • getPresentationFormat

        java.lang.String getPresentationFormat()

        Returns or sets the intended format of a presentation. Read/write String.

      • setPresentationFormat

        void setPresentationFormat(java.lang.String value)

        Returns or sets the intended format of a presentation. Read/write String.

      • getSharedDoc

        boolean getSharedDoc()

        Determines whether the presentation is shared between multiple people. Read/write boolean.

      • setSharedDoc

        void setSharedDoc(boolean value)

        Determines whether the presentation is shared between multiple people. Read/write boolean.

      • getApplicationTemplate

        java.lang.String getApplicationTemplate()

        Returns or sets the template of a application. Read/write String.

      • setApplicationTemplate

        void setApplicationTemplate(java.lang.String value)

        Returns or sets the template of a application. Read/write String.

      • getTotalEditingTime

        double getTotalEditingTime()

        Total editing time of a presentation. Read/write double.

      • setTotalEditingTime

        void setTotalEditingTime(double value)

        Total editing time of a presentation. Read/write double.

      • getTitle

        java.lang.String getTitle()

        Returns or sets the title of a presentation. Read/write String.

      • setTitle

        void setTitle(java.lang.String value)

        Returns or sets the title of a presentation. Read/write String.

      • getSubject

        java.lang.String getSubject()

        Returns or sets the subject of a presentation. Read/write String.

      • setSubject

        void setSubject(java.lang.String value)

        Returns or sets the subject of a presentation. Read/write String.

      • getAuthor

        java.lang.String getAuthor()

        Returns or sets the author of a presentation. Read/write String.

      • setAuthor

        void setAuthor(java.lang.String value)

        Returns or sets the author of a presentation. Read/write String.

      • getKeywords

        java.lang.String getKeywords()

        Returns or sets the keywords of a presentation. Read/write String.

      • setKeywords

        void setKeywords(java.lang.String value)

        Returns or sets the keywords of a presentation. Read/write String.

      • getComments

        java.lang.String getComments()

        Returns or sets the comments of a presentation. Read/write String.

      • setComments

        void setComments(java.lang.String value)

        Returns or sets the comments of a presentation. Read/write String.

      • getCategory

        java.lang.String getCategory()

        Returns or sets the category of a presentation. Read/write String.

      • setCategory

        void setCategory(java.lang.String value)

        Returns or sets the category of a presentation. Read/write String.

      • getCreatedTime

        java.util.Date getCreatedTime()

        Returns the date when a presentation was created. Read/write Date.

      • setCreatedTime

        void setCreatedTime(java.util.Date value)

        Returns the date when a presentation was created. Read/write Date.

      • getLastPrinted

        java.util.Date getLastPrinted()

        Returns the date when a presentation was printed last time. Read/write Date.

      • setLastPrinted

        void setLastPrinted(java.util.Date value)

        Returns the date when a presentation was printed last time. Read/write Date.

      • getLastSavedBy

        java.lang.String getLastSavedBy()

        Returns or sets the name of a last person who modified a presentation. Read/write String.

      • setLastSavedBy

        void setLastSavedBy(java.lang.String value)

        Returns or sets the name of a last person who modified a presentation. Read/write String.

      • getRevisionNumber

        int getRevisionNumber()

        Returns or sets the presentation revision number. Read/write int.

      • setRevisionNumber

        void setRevisionNumber(int value)

        Returns or sets the presentation revision number. Read/write int.

      • getContentStatus

        java.lang.String getContentStatus()

        Returns or sets the content status of a presentation. Read/write String.

      • setContentStatus

        void setContentStatus(java.lang.String value)

        Returns or sets the content status of a presentation. Read/write String.

      • getContentType

        java.lang.String getContentType()

        Returns or sets the content type of a presentation. Read/write String.

      • setContentType

        void setContentType(java.lang.String value)

        Returns or sets the content type of a presentation. Read/write String.

      • getHyperlinkBase

        java.lang.String getHyperlinkBase()

        Returns or sets the HyperlinkBase document property. Read/write String.

      • setHyperlinkBase

        void setHyperlinkBase(java.lang.String value)

        Returns or sets the HyperlinkBase document property. Read/write String.

      • getCountOfCustomProperties

        int getCountOfCustomProperties()

        Returns the number of custom properties actually contained in a collection. Read-only int.

      • getCustomPropertyName

        java.lang.String getCustomPropertyName(int index)

        Return a custom property name at the specified index.

        Parameters:
        index - The zero-based index of a custom property to get.
        Returns:
        Custom property name at the specified index.
        Throws:
        com.aspose.ms.System.ArgumentOutOfRangeException - Index is less than zero. Index is equal to or greater than Count.
      • removeCustomProperty

        boolean removeCustomProperty(java.lang.String name)

        Remove a custom property associated with a specified name.

        Parameters:
        name - Name of a custom property to remove.
        Returns:
        Return true if a property was removed, false overwise.
      • containsCustomProperty

        boolean containsCustomProperty(java.lang.String name)

        Check presents of a custom property with a specified name.

        Parameters:
        name - Name of a custom property to check.
        Returns:
        Return true if property exists, false overwise.
      • get_Item

        java.lang.Object get_Item(java.lang.String name)

        Returns or sets the custom property associated with a specified name. Read/write Object.


        Value can be <b>int</b>, <b>float</b>, <b>double</b>, <b>string</b>, <b>bool</b> or <b>DateTime</b>.

      • set_Item

        void set_Item(java.lang.String name,
                      java.lang.Object value)

        Returns or sets the custom property associated with a specified name. Read/write Object.


        Value can be <b>int</b>, <b>float</b>, <b>double</b>, <b>string</b>, <b>bool</b> or <b>DateTime</b>.

      • clearCustomProperties

        void clearCustomProperties()

        Removes all custom properties.

      • clearBuiltInProperties

        void clearBuiltInProperties()

        Clears and sets default values for all builtIn properties.

      • getCustomPropertyValue

        void getCustomPropertyValue(java.lang.String name,
                                    boolean[] value)

        Gets a named boolean value from the custom properties.

        Parameters:
        name - Name of the custom property to get
        value - Custom property value
      • getCustomPropertyValue

        void getCustomPropertyValue(java.lang.String name,
                                    int[] value)

        Gets a named integer value from the custom properties.

        Parameters:
        name - Name of the custom property to get
        value - Custom property value
      • getCustomPropertyValue

        void getCustomPropertyValue(java.lang.String name,
                                    java.util.Date[] value)

        Gets a named DateTime value from the custom properties.

        Parameters:
        name - Name of the custom property to get
        value - Custom property value
      • getCustomPropertyValue

        void getCustomPropertyValue(java.lang.String name,
                                    java.lang.String[] value)

        Gets a named string value from the custom properties.

        Parameters:
        name - Name of the custom property to get
        value - Custom property value
      • getCustomPropertyValue

        void getCustomPropertyValue(java.lang.String name,
                                    float[] value)

        Gets a named float value from the custom properties.

        Parameters:
        name - Name of the custom property to get
        value - Custom property value
      • getCustomPropertyValue

        void getCustomPropertyValue(java.lang.String name,
                                    double[] value)

        Gets a named double value from the custom properties.

        Parameters:
        name - Name of the custom property to get.
        value - Custom property value
      • setCustomPropertyValue

        void setCustomPropertyValue(java.lang.String name,
                                    boolean value)

        Sets a named boolean custom property.

        Parameters:
        name - Name of the custom property to set
        value - Custom property value
      • setCustomPropertyValue

        void setCustomPropertyValue(java.lang.String name,
                                    int value)

        Sets a named integer custom property.

        Parameters:
        name - Name of the custom property to set
        value - Custom property value
      • setCustomPropertyValue

        void setCustomPropertyValue(java.lang.String name,
                                    java.util.Date value)

        Sets a named DateTime custom property.

        Parameters:
        name - Name of the custom property to set
        value - Custom property value
      • setCustomPropertyValue

        void setCustomPropertyValue(java.lang.String name,
                                    java.lang.String value)

        Sets a named string custom property.

        Parameters:
        name - Name of the custom property to set
        value - Custom property value
      • setCustomPropertyValue

        void setCustomPropertyValue(java.lang.String name,
                                    float value)

        Sets a named float custom property.

        Parameters:
        name - Name of the custom property to set
        value - Custom property value
      • setCustomPropertyValue

        void setCustomPropertyValue(java.lang.String name,
                                    double value)

        Sets a named double custom property.

        Parameters:
        name - Name of the custom property to set
        value - Custom property value