IDocumentProperties
public interface IDocumentProperties
Represents properties of a presentation.
Methods
Method | Description |
---|---|
getAppVersion() | Returns the app version. |
getNameOfApplication() | Returns or sets the name of the application. |
setNameOfApplication(String value) | Returns or sets the name of the application. |
getCompany() | Returns or sets the company property. |
setCompany(String value) | Returns or sets the company property. |
getManager() | Returns or sets the manager property. |
setManager(String value) | Returns or sets the manager property. |
getPresentationFormat() | Returns or sets the intended format of a presentation. |
setPresentationFormat(String value) | Returns or sets the intended format of a presentation. |
getSharedDoc() | Determines whether the presentation is shared between multiple people. |
setSharedDoc(boolean value) | Determines whether the presentation is shared between multiple people. |
getApplicationTemplate() | Returns or sets the template of a application. |
setApplicationTemplate(String value) | Returns or sets the template of a application. |
getTotalEditingTime() | Total editing time of a presentation. |
setTotalEditingTime(double value) | Total editing time of a presentation. |
getTitle() | Returns or sets the title of a presentation. |
setTitle(String value) | Returns or sets the title of a presentation. |
getSubject() | Returns or sets the subject of a presentation. |
setSubject(String value) | Returns or sets the subject of a presentation. |
getAuthor() | Returns or sets the author of a presentation. |
setAuthor(String value) | Returns or sets the author of a presentation. |
getKeywords() | Returns or sets the keywords of a presentation. |
setKeywords(String value) | Returns or sets the keywords of a presentation. |
getComments() | Returns or sets the comments of a presentation. |
setComments(String value) | Returns or sets the comments of a presentation. |
getCategory() | Returns or sets the category of a presentation. |
setCategory(String value) | Returns or sets the category of a presentation. |
getCreatedTime() | Returns the date a presentation was created. |
setCreatedTime(Date value) | Returns the date a presentation was created. |
getLastSavedTime() | Returns the date a presentation was last modified. |
setLastSavedTime(Date value) | Returns the date a presentation was last modified. |
getLastPrinted() | Returns the date when a presentation was printed last time. |
setLastPrinted(Date value) | Returns the date when a presentation was printed last time. |
getLastSavedBy() | Returns or sets the name of a last person who modified a presentation. |
setLastSavedBy(String value) | Returns or sets the name of a last person who modified a presentation. |
getRevisionNumber() | Returns or sets the presentation revision number. |
setRevisionNumber(int value) | Returns or sets the presentation revision number. |
getContentStatus() | Returns or sets the content status of a presentation. |
setContentStatus(String value) | Returns or sets the content status of a presentation. |
getContentType() | Returns or sets the content type of a presentation. |
setContentType(String value) | Returns or sets the content type of a presentation. |
getHyperlinkBase() | Returns or sets the HyperlinkBase document property. |
setHyperlinkBase(String value) | Returns or sets the HyperlinkBase document property. |
getScaleCrop() | Indicates the display mode of the document thumbnail. |
setScaleCrop(boolean value) | Indicates the display mode of the document thumbnail. |
getLinksUpToDate() | Indicates whether hyperlinks in a document are up-to-date. |
setLinksUpToDate(boolean value) | Indicates whether hyperlinks in a document are up-to-date. |
getHyperlinksChanged() | Specifies that one or more hyperlinks in this part were updated exclusively in this part by a producer. |
setHyperlinksChanged(boolean value) | Specifies that one or more hyperlinks in this part were updated exclusively in this part by a producer. |
getSlides() | Specifies the total number of slides in a presentation document. |
getHiddenSlides() | Specifies the number of hidden slides in a presentation document. |
getNotes() | Specifies the number of slides in a presentation containing notes. |
getParagraphs() | Specifies the total number of paragraphs found in a document if applicable. |
getWords() | Specifies the total number of words contained in a document. |
getMultimediaClips() | Specifies the total number of sound or video clips that are present in the document. |
getTitlesOfParts() | Specifies the title of each document part. |
getHeadingPairs() | Indicates the grouping of document parts and the number of parts in each group. |
getCountOfCustomProperties() | Returns the number of custom properties actually contained in a collection. |
getCustomPropertyName(int index) | Return a custom property name at the specified index. |
removeCustomProperty(String name) | Remove a custom property associated with a specified name. |
containsCustomProperty(String name) | Check presents of a custom property with a specified name. |
get_Item(String name) | Returns or sets the custom property associated with a specified name. |
set_Item(String name, Object value) | Returns or sets the custom property associated with a specified name. |
clearCustomProperties() | Removes all custom properties. |
clearBuiltInProperties() | Clears and sets default values for all builtIn properties. |
getCustomPropertyValue(String name, boolean[] value) | Gets a named boolean value from the custom properties. |
getCustomPropertyValue(String name, int[] value) | Gets a named integer value from the custom properties. |
getCustomPropertyValue(String name, Date[] value) | Gets a named DateTime value from the custom properties. |
getCustomPropertyValue(String name, String[] value) | Gets a named string value from the custom properties. |
getCustomPropertyValue(String name, float[] value) | Gets a named float value from the custom properties. |
getCustomPropertyValue(String name, double[] value) | Gets a named double value from the custom properties. |
setCustomPropertyValue(String name, boolean value) | Sets a named boolean custom property. |
setCustomPropertyValue(String name, int value) | Sets a named integer custom property. |
setCustomPropertyValue(String name, Date value) | Sets a named DateTime custom property. |
setCustomPropertyValue(String name, String value) | Sets a named string custom property. |
setCustomPropertyValue(String name, float value) | Sets a named float custom property. |
setCustomPropertyValue(String name, double value) | Sets a named double custom property. |
getAppVersion()
public abstract String getAppVersion()
Returns the app version. Read-only String.
The content of this element shall be in the form XX.YYYY, where X and Y represent numerical values; otherwise, the document shall be considered non-conformant. Aspose.Slides represents its version in the format XX.YY.ZZ, where: XX - major version YY - minor version ZZ - patch version For example, the value 23.0105 means Aspose.Slides version 23.1.5.
Returns: java.lang.String
getNameOfApplication()
public abstract String getNameOfApplication()
Returns or sets the name of the application. Read/write String.
Returns: java.lang.String
setNameOfApplication(String value)
public abstract void setNameOfApplication(String value)
Returns or sets the name of the application. Read/write String.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String |
getCompany()
public abstract String getCompany()
Returns or sets the company property. Read/write String.
Returns: java.lang.String
setCompany(String value)
public abstract void setCompany(String value)
Returns or sets the company property. Read/write String.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String |
getManager()
public abstract String getManager()
Returns or sets the manager property. Read/write String.
Returns: java.lang.String
setManager(String value)
public abstract void setManager(String value)
Returns or sets the manager property. Read/write String.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String |
getPresentationFormat()
public abstract String getPresentationFormat()
Returns or sets the intended format of a presentation. Read/write String.
Returns: java.lang.String
setPresentationFormat(String value)
public abstract void setPresentationFormat(String value)
Returns or sets the intended format of a presentation. Read/write String.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String |
getSharedDoc()
public abstract boolean getSharedDoc()
Determines whether the presentation is shared between multiple people. Read/write boolean.
Returns: boolean
setSharedDoc(boolean value)
public abstract void setSharedDoc(boolean value)
Determines whether the presentation is shared between multiple people. Read/write boolean.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
getApplicationTemplate()
public abstract String getApplicationTemplate()
Returns or sets the template of a application. Read/write String.
Returns: java.lang.String
setApplicationTemplate(String value)
public abstract void setApplicationTemplate(String value)
Returns or sets the template of a application. Read/write String.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String |
getTotalEditingTime()
public abstract double getTotalEditingTime()
Total editing time of a presentation. Read/write double.
Returns: double
setTotalEditingTime(double value)
public abstract void setTotalEditingTime(double value)
Total editing time of a presentation. Read/write double.
Parameters:
Parameter | Type | Description |
---|---|---|
value | double |
getTitle()
public abstract String getTitle()
Returns or sets the title of a presentation. Read/write String.
Returns: java.lang.String
setTitle(String value)
public abstract void setTitle(String value)
Returns or sets the title of a presentation. Read/write String.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String |
getSubject()
public abstract String getSubject()
Returns or sets the subject of a presentation. Read/write String.
Returns: java.lang.String
setSubject(String value)
public abstract void setSubject(String value)
Returns or sets the subject of a presentation. Read/write String.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String |
getAuthor()
public abstract String getAuthor()
Returns or sets the author of a presentation. Read/write String.
Returns: java.lang.String
setAuthor(String value)
public abstract void setAuthor(String value)
Returns or sets the author of a presentation. Read/write String.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String |
getKeywords()
public abstract String getKeywords()
Returns or sets the keywords of a presentation. Read/write String.
Returns: java.lang.String
setKeywords(String value)
public abstract void setKeywords(String value)
Returns or sets the keywords of a presentation. Read/write String.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String |
getComments()
public abstract String getComments()
Returns or sets the comments of a presentation. Read/write String.
Returns: java.lang.String
setComments(String value)
public abstract void setComments(String value)
Returns or sets the comments of a presentation. Read/write String.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String |
getCategory()
public abstract String getCategory()
Returns or sets the category of a presentation. Read/write String.
Returns: java.lang.String
setCategory(String value)
public abstract void setCategory(String value)
Returns or sets the category of a presentation. Read/write String.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String |
getCreatedTime()
public abstract Date getCreatedTime()
Returns the date a presentation was created. Values are in UTC. Read/write java.util.Date.
Returns: java.util.Date
setCreatedTime(Date value)
public abstract void setCreatedTime(Date value)
Returns the date a presentation was created. Values are in UTC. Read/write java.util.Date.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.util.Date |
getLastSavedTime()
public abstract Date getLastSavedTime()
Returns the date a presentation was last modified. Values are in UTC.P Read-only in case of Presentation.DocumentProperties (because it will be updated internally while IPresentation object saving process). Can be changed via DocumentProperties instance returning by method IPresentationInfo.readDocumentProperties Please see the example in IPresentationInfo.updateDocumentProperties(IDocumentProperties) method summary.
Returns: java.util.Date
setLastSavedTime(Date value)
public abstract void setLastSavedTime(Date value)
Returns the date a presentation was last modified. Values are in UTC.P Read-only in case of Presentation.DocumentProperties (because it will be updated internally while IPresentation object saving process). Can be changed via DocumentProperties instance returning by method IPresentationInfo.readDocumentProperties Please see the example in IPresentationInfo.updateDocumentProperties(IDocumentProperties) method summary.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.util.Date |
getLastPrinted()
public abstract Date getLastPrinted()
Returns the date when a presentation was printed last time. Read/write java.util.Date.
Returns: java.util.Date
setLastPrinted(Date value)
public abstract void setLastPrinted(Date value)
Returns the date when a presentation was printed last time. Read/write java.util.Date.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.util.Date |
getLastSavedBy()
public abstract String getLastSavedBy()
Returns or sets the name of a last person who modified a presentation. Read/write String.
Returns: java.lang.String
setLastSavedBy(String value)
public abstract void setLastSavedBy(String value)
Returns or sets the name of a last person who modified a presentation. Read/write String.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String |
getRevisionNumber()
public abstract int getRevisionNumber()
Returns or sets the presentation revision number. Read/write int.
Returns: int
setRevisionNumber(int value)
public abstract void setRevisionNumber(int value)
Returns or sets the presentation revision number. Read/write int.
Parameters:
Parameter | Type | Description |
---|---|---|
value | int |
getContentStatus()
public abstract String getContentStatus()
Returns or sets the content status of a presentation. Read/write String.
Returns: java.lang.String
setContentStatus(String value)
public abstract void setContentStatus(String value)
Returns or sets the content status of a presentation. Read/write String.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String |
getContentType()
public abstract String getContentType()
Returns or sets the content type of a presentation. Read/write String.
Returns: java.lang.String
setContentType(String value)
public abstract void setContentType(String value)
Returns or sets the content type of a presentation. Read/write String.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String |
getHyperlinkBase()
public abstract String getHyperlinkBase()
Returns or sets the HyperlinkBase document property. Read/write String.
Returns: java.lang.String
setHyperlinkBase(String value)
public abstract void setHyperlinkBase(String value)
Returns or sets the HyperlinkBase document property. Read/write String.
Parameters:
Parameter | Type | Description |
---|---|---|
value | java.lang.String |
getScaleCrop()
public abstract boolean getScaleCrop()
Indicates the display mode of the document thumbnail. Set this element to true to enable scaling of the document thumbnail to the display. Set this element to false to enable cropping of the document thumbnail to show only sections that fits the display. Read/write boolean.
Returns: boolean
setScaleCrop(boolean value)
public abstract void setScaleCrop(boolean value)
Indicates the display mode of the document thumbnail. Set this element to true to enable scaling of the document thumbnail to the display. Set this element to false to enable cropping of the document thumbnail to show only sections that fits the display. Read/write boolean.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
getLinksUpToDate()
public abstract boolean getLinksUpToDate()
Indicates whether hyperlinks in a document are up-to-date. Set this element to true to indicate that hyperlinks are updated. Set this element to false to indicate that hyperlinks are outdated. Read/write boolean.
Returns: boolean
setLinksUpToDate(boolean value)
public abstract void setLinksUpToDate(boolean value)
Indicates whether hyperlinks in a document are up-to-date. Set this element to true to indicate that hyperlinks are updated. Set this element to false to indicate that hyperlinks are outdated. Read/write boolean.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
getHyperlinksChanged()
public abstract boolean getHyperlinksChanged()
Specifies that one or more hyperlinks in this part were updated exclusively in this part by a producer. The next producer to open this document shall update the hyperlink relationships with the new hyperlinks specified in this part. Read/write boolean.
Returns: boolean
setHyperlinksChanged(boolean value)
public abstract void setHyperlinksChanged(boolean value)
Specifies that one or more hyperlinks in this part were updated exclusively in this part by a producer. The next producer to open this document shall update the hyperlink relationships with the new hyperlinks specified in this part. Read/write boolean.
Parameters:
Parameter | Type | Description |
---|---|---|
value | boolean |
getSlides()
public abstract int getSlides()
Specifies the total number of slides in a presentation document. Read-only int.
Returns: int
getHiddenSlides()
public abstract int getHiddenSlides()
Specifies the number of hidden slides in a presentation document. Read-only int.
Returns: int
getNotes()
public abstract int getNotes()
Specifies the number of slides in a presentation containing notes. Read-only int.
Returns: int
getParagraphs()
public abstract int getParagraphs()
Specifies the total number of paragraphs found in a document if applicable. Read-only int.
Returns: int
getWords()
public abstract int getWords()
Specifies the total number of words contained in a document. Read-only int.
Returns: int
getMultimediaClips()
public abstract int getMultimediaClips()
Specifies the total number of sound or video clips that are present in the document. Read-only int.
Returns: int
getTitlesOfParts()
public abstract String[] getTitlesOfParts()
Specifies the title of each document part. These parts are not document parts but conceptual representations of document sections. Read-only String[].
Returns: java.lang.String[]
getHeadingPairs()
public abstract IHeadingPair[] getHeadingPairs()
Indicates the grouping of document parts and the number of parts in each group. Read-only IHeadingPair[].
Returns: com.aspose.slides.IHeadingPair[]
getCountOfCustomProperties()
public abstract int getCountOfCustomProperties()
Returns the number of custom properties actually contained in a collection. Read-only int.
Returns: int
getCustomPropertyName(int index)
public abstract String getCustomPropertyName(int index)
Return a custom property name at the specified index.
Parameters:
Parameter | Type | Description |
---|---|---|
index | int | The zero-based index of a custom property to get. |
Returns: java.lang.String - Custom property name at the specified index.
removeCustomProperty(String name)
public abstract boolean removeCustomProperty(String name)
Remove a custom property associated with a specified name.
Parameters:
Parameter | Type | Description |
---|---|---|
name | java.lang.String | Name of a custom property to remove. |
Returns: boolean - Return true if a property was removed, false otherwise.
containsCustomProperty(String name)
public abstract boolean containsCustomProperty(String name)
Check presents of a custom property with a specified name.
Parameters:
Parameter | Type | Description |
---|---|---|
name | java.lang.String | Name of a custom property to check. |
Returns: boolean - Return true if property exists, false otherwise.
get_Item(String name)
public abstract Object get_Item(String name)
Returns or sets the custom property associated with a specified name. Read/write Object.
Value can be int, float, double, String, boolean or Date.
Parameters:
Parameter | Type | Description |
---|---|---|
name | java.lang.String |
Returns: java.lang.Object
set_Item(String name, Object value)
public abstract void set_Item(String name, Object value)
Returns or sets the custom property associated with a specified name. Read/write Object.
Value can be int, float, double, String, boolean or Date.
Parameters:
Parameter | Type | Description |
---|---|---|
name | java.lang.String | |
value | java.lang.Object |
clearCustomProperties()
public abstract void clearCustomProperties()
Removes all custom properties.
clearBuiltInProperties()
public abstract void clearBuiltInProperties()
Clears and sets default values for all builtIn properties.
getCustomPropertyValue(String name, boolean[] value)
public abstract void getCustomPropertyValue(String name, boolean[] value)
Gets a named boolean value from the custom properties.
Parameters:
Parameter | Type | Description |
---|---|---|
name | java.lang.String | Name of the custom property to get |
value | boolean[] | Custom property value |
getCustomPropertyValue(String name, int[] value)
public abstract void getCustomPropertyValue(String name, int[] value)
Gets a named integer value from the custom properties.
Parameters:
Parameter | Type | Description |
---|---|---|
name | java.lang.String | Name of the custom property to get |
value | int[] | Custom property value |
getCustomPropertyValue(String name, Date[] value)
public abstract void getCustomPropertyValue(String name, Date[] value)
Gets a named DateTime value from the custom properties.
Parameters:
Parameter | Type | Description |
---|---|---|
name | java.lang.String | Name of the custom property to get |
value | java.util.Date[] | Custom property value |
getCustomPropertyValue(String name, String[] value)
public abstract void getCustomPropertyValue(String name, String[] value)
Gets a named string value from the custom properties.
Parameters:
Parameter | Type | Description |
---|---|---|
name | java.lang.String | Name of the custom property to get |
value | java.lang.String[] | Custom property value |
getCustomPropertyValue(String name, float[] value)
public abstract void getCustomPropertyValue(String name, float[] value)
Gets a named float value from the custom properties.
Parameters:
Parameter | Type | Description |
---|---|---|
name | java.lang.String | Name of the custom property to get |
value | float[] | Custom property value |
getCustomPropertyValue(String name, double[] value)
public abstract void getCustomPropertyValue(String name, double[] value)
Gets a named double value from the custom properties.
Parameters:
Parameter | Type | Description |
---|---|---|
name | java.lang.String | Name of the custom property to get. |
value | double[] | Custom property value |
setCustomPropertyValue(String name, boolean value)
public abstract void setCustomPropertyValue(String name, boolean value)
Sets a named boolean custom property.
Parameters:
Parameter | Type | Description |
---|---|---|
name | java.lang.String | Name of the custom property to set |
value | boolean | Custom property value |
setCustomPropertyValue(String name, int value)
public abstract void setCustomPropertyValue(String name, int value)
Sets a named integer custom property.
Parameters:
Parameter | Type | Description |
---|---|---|
name | java.lang.String | Name of the custom property to set |
value | int | Custom property value |
setCustomPropertyValue(String name, Date value)
public abstract void setCustomPropertyValue(String name, Date value)
Sets a named DateTime custom property.
Parameters:
Parameter | Type | Description |
---|---|---|
name | java.lang.String | Name of the custom property to set |
value | java.util.Date | Custom property value |
setCustomPropertyValue(String name, String value)
public abstract void setCustomPropertyValue(String name, String value)
Sets a named string custom property.
Parameters:
Parameter | Type | Description |
---|---|---|
name | java.lang.String | Name of the custom property to set |
value | java.lang.String | Custom property value |
setCustomPropertyValue(String name, float value)
public abstract void setCustomPropertyValue(String name, float value)
Sets a named float custom property.
Parameters:
Parameter | Type | Description |
---|---|---|
name | java.lang.String | Name of the custom property to set |
value | float | Custom property value |
setCustomPropertyValue(String name, double value)
public abstract void setCustomPropertyValue(String name, double value)
Sets a named double custom property.
Parameters:
Parameter | Type | Description |
---|---|---|
name | java.lang.String | Name of the custom property to set |
value | double | Custom property value |