com.aspose.slides

Class DocumentProperties

java.lang.Object

com.aspose.slides.DocumentProperties

All Implemented Interfaces:

IDocumentProperties, IGenericCloneable<IDocumentProperties>, java.lang.Cloneable

public class DocumentProperties
extends java.lang.Object
implements IDocumentProperties, IGenericCloneable<IDocumentProperties>, java.lang.Cloneable

Represents properties of a presentation.

Constructor Summary

Constructors

Constructor and Description
DocumentProperties() Initializes new instance of class DocumentProperties.

Method Summary

Modifier and Type	Method and Description
void	clearBuiltInProperties() Clears and sets default values for all builtIn properties.
void	clearCustomProperties() Removes all custom properties.
IDocumentProperties	cloneT() Clones current object
boolean	containsCustomProperty(java.lang.String name) Check presents of a custom property with a specified name.
java.lang.Object	deepClone() Clones current object
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.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DocumentProperties

public DocumentProperties()

Initializes new instance of class DocumentProperties.

Method Detail

getAppVersion

public final java.lang.String getAppVersion()

Returns the app version. Read-only String.

Specified by:

getAppVersion in interface IDocumentProperties

getNameOfApplication

public final java.lang.String getNameOfApplication()

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

Specified by:

getNameOfApplication in interface IDocumentProperties

setNameOfApplication

public final void setNameOfApplication(java.lang.String value)

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

Specified by:

setNameOfApplication in interface IDocumentProperties

getCompany

public final java.lang.String getCompany()

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

Specified by:

getCompany in interface IDocumentProperties

setCompany

public final void setCompany(java.lang.String value)

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

Specified by:

setCompany in interface IDocumentProperties

getManager

public final java.lang.String getManager()

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

Specified by:

getManager in interface IDocumentProperties

setManager

public final void setManager(java.lang.String value)

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

Specified by:

setManager in interface IDocumentProperties

getPresentationFormat

public final java.lang.String getPresentationFormat()

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

Specified by:

getPresentationFormat in interface IDocumentProperties

setPresentationFormat

public final void setPresentationFormat(java.lang.String value)

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

Specified by:

setPresentationFormat in interface IDocumentProperties

getSharedDoc

public final boolean getSharedDoc()

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

Specified by:

getSharedDoc in interface IDocumentProperties

setSharedDoc

public final void setSharedDoc(boolean value)

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

Specified by:

setSharedDoc in interface IDocumentProperties

getApplicationTemplate

public final java.lang.String getApplicationTemplate()

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

Specified by:

getApplicationTemplate in interface IDocumentProperties

setApplicationTemplate

public final void setApplicationTemplate(java.lang.String value)

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

Specified by:

setApplicationTemplate in interface IDocumentProperties

getTotalEditingTime

public final double getTotalEditingTime()

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

Specified by:

getTotalEditingTime in interface IDocumentProperties

setTotalEditingTime

public final void setTotalEditingTime(double value)

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

Specified by:

setTotalEditingTime in interface IDocumentProperties

getTitle

public final java.lang.String getTitle()

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

Specified by:

getTitle in interface IDocumentProperties

setTitle

public final void setTitle(java.lang.String value)

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

Specified by:

setTitle in interface IDocumentProperties

getSubject

public final java.lang.String getSubject()

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

Specified by:

getSubject in interface IDocumentProperties

setSubject

public final void setSubject(java.lang.String value)

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

Specified by:

setSubject in interface IDocumentProperties

getAuthor

public final java.lang.String getAuthor()

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

Specified by:

getAuthor in interface IDocumentProperties

setAuthor

public final void setAuthor(java.lang.String value)

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

Specified by:

setAuthor in interface IDocumentProperties

getKeywords

public final java.lang.String getKeywords()

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

Specified by:

getKeywords in interface IDocumentProperties

setKeywords

public final void setKeywords(java.lang.String value)

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

Specified by:

setKeywords in interface IDocumentProperties

getComments

public final java.lang.String getComments()

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

Specified by:

getComments in interface IDocumentProperties

setComments

public final void setComments(java.lang.String value)

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

Specified by:

setComments in interface IDocumentProperties

getCategory

public final java.lang.String getCategory()

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

Specified by:

getCategory in interface IDocumentProperties

setCategory

public final void setCategory(java.lang.String value)

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

Specified by:

setCategory in interface IDocumentProperties

getCreatedTime

public final java.util.Date getCreatedTime()

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

Specified by:

getCreatedTime in interface IDocumentProperties

setCreatedTime

public final void setCreatedTime(java.util.Date value)

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

Specified by:

setCreatedTime in interface IDocumentProperties

getLastSavedTime

public final java.util.Date getLastSavedTime()

Returns the date when a presentation was modified last time. 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.

Specified by:

getLastSavedTime in interface IDocumentProperties

setLastSavedTime

public final void setLastSavedTime(java.util.Date value)

Returns the date when a presentation was modified last time. 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.

Specified by:

setLastSavedTime in interface IDocumentProperties

getLastPrinted

public final java.util.Date getLastPrinted()

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

Specified by:

getLastPrinted in interface IDocumentProperties

setLastPrinted

public final void setLastPrinted(java.util.Date value)

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

Specified by:

setLastPrinted in interface IDocumentProperties

getLastSavedBy

public final java.lang.String getLastSavedBy()

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

Specified by:

getLastSavedBy in interface IDocumentProperties

setLastSavedBy

public final void setLastSavedBy(java.lang.String value)

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

Specified by:

setLastSavedBy in interface IDocumentProperties

getRevisionNumber

public final int getRevisionNumber()

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

Specified by:

getRevisionNumber in interface IDocumentProperties

setRevisionNumber

public final void setRevisionNumber(int value)

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

Specified by:

setRevisionNumber in interface IDocumentProperties

getContentStatus

public final java.lang.String getContentStatus()

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

Specified by:

getContentStatus in interface IDocumentProperties

setContentStatus

public final void setContentStatus(java.lang.String value)

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

Specified by:

setContentStatus in interface IDocumentProperties

getContentType

public final java.lang.String getContentType()

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

Specified by:

getContentType in interface IDocumentProperties

setContentType

public final void setContentType(java.lang.String value)

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

Specified by:

setContentType in interface IDocumentProperties

getHyperlinkBase

public final java.lang.String getHyperlinkBase()

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

Specified by:

getHyperlinkBase in interface IDocumentProperties

setHyperlinkBase

public final void setHyperlinkBase(java.lang.String value)

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

Specified by:

setHyperlinkBase in interface IDocumentProperties

getCountOfCustomProperties

public final int getCountOfCustomProperties()

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

Specified by:

getCountOfCustomProperties in interface IDocumentProperties

getCustomPropertyName

public final java.lang.String getCustomPropertyName(int index)

Return a custom property name at the specified index.

Specified by:

getCustomPropertyName in interface IDocumentProperties

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

public final boolean removeCustomProperty(java.lang.String name)

Remove a custom property associated with a specified name.

Specified by:

removeCustomProperty in interface IDocumentProperties

Parameters:

name - Name of a custom property to remove.

Returns:

Return true if a property was removed, false overwise.

containsCustomProperty

public final boolean containsCustomProperty(java.lang.String name)

Check presents of a custom property with a specified name.

Specified by:

containsCustomProperty in interface IDocumentProperties

Parameters:

name - Name of a custom property to check.

Returns:

Return true if property exists, false overwise.

get_Item

public final 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 int, float, String, boolean or Date.

Specified by:

get_Item in interface IDocumentProperties

set_Item

public final 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 int, float, String, boolean or Date.

Specified by:

set_Item in interface IDocumentProperties

getCustomPropertyValue

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

Gets a named boolean value from the custom properties.

Specified by:

getCustomPropertyValue in interface IDocumentProperties

Parameters:

name - Name of the custom property to get

value - Custom property value

getCustomPropertyValue

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

Gets a named integer value from the custom properties.

Specified by:

getCustomPropertyValue in interface IDocumentProperties

Parameters:

name - Name of the custom property to get

value - Custom property value

getCustomPropertyValue

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

Gets a named DateTime value from the custom properties.

Specified by:

getCustomPropertyValue in interface IDocumentProperties

Parameters:

name - Name of the custom property to get

value - Custom property value

getCustomPropertyValue

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

Gets a named string value from the custom properties.

Specified by:

getCustomPropertyValue in interface IDocumentProperties

Parameters:

name - Name of the custom property to get

value - Custom property value

getCustomPropertyValue

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

Gets a named float value from the custom properties.

Specified by:

getCustomPropertyValue in interface IDocumentProperties

Parameters:

name - Name of the custom property to get

value - Custom property value

getCustomPropertyValue

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

Gets a named double value from the custom properties.

Specified by:

getCustomPropertyValue in interface IDocumentProperties

Parameters:

name - Name of the custom property to get.

value - Custom property value

setCustomPropertyValue

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

Sets a named boolean custom property.

Specified by:

setCustomPropertyValue in interface IDocumentProperties

Parameters:

name - Name of the custom property to set

value - Custom property value

setCustomPropertyValue

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

Sets a named integer custom property.

Specified by:

setCustomPropertyValue in interface IDocumentProperties

Parameters:

name - Name of the custom property to set

value - Custom property value

setCustomPropertyValue

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

Sets a named DateTime custom property.

Specified by:

setCustomPropertyValue in interface IDocumentProperties

Parameters:

name - Name of the custom property to set

value - Custom property value

setCustomPropertyValue

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

Sets a named string custom property.

Specified by:

setCustomPropertyValue in interface IDocumentProperties

Parameters:

name - Name of the custom property to set

value - Custom property value

setCustomPropertyValue

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

Sets a named float custom property.

Specified by:

setCustomPropertyValue in interface IDocumentProperties

Parameters:

name - Name of the custom property to set

value - Custom property value

setCustomPropertyValue

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

Sets a named double custom property.

Specified by:

setCustomPropertyValue in interface IDocumentProperties

Parameters:

name - Name of the custom property to set

value - Custom property value

clearCustomProperties

public final void clearCustomProperties()

Removes all custom properties.

Specified by:

clearCustomProperties in interface IDocumentProperties

clearBuiltInProperties

public final void clearBuiltInProperties()

Clears and sets default values for all builtIn properties.

Specified by:

clearBuiltInProperties in interface IDocumentProperties

deepClone

public final java.lang.Object deepClone()

Clones current object

Returns:

Clone

cloneT

public final IDocumentProperties cloneT()

Clones current object

Specified by:

cloneT in interface IGenericCloneable<IDocumentProperties>

Returns:

Clone