com.aspose.slides
Class DocumentProperties

java.lang.Object
  extended by com.aspose.slides.DocumentProperties
All Implemented Interfaces:
IDocumentProperties

public class DocumentProperties
extends java.lang.Object
implements IDocumentProperties

Represents properties of a presentation.


Method Summary
 void clearBuiltInProperties()
           / Clears and sets default values for all builtIn properties.
 void clearCustomProperties()
           / Removes all custom properties.
 boolean contains(java.lang.String name)
          Deprecated. 
 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 getCount()
          Deprecated. 
 int getCountOfCustomProperties()
           Returns the number of custom properties actually contained in a collection.
 java.util.Date getCreatedTime()
           Returns or sets 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 or sets 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 or sets 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.
 java.lang.String getPropertyName(int index)
          Deprecated. 
 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 remove(java.lang.String name)
          Deprecated. 
 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 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 setLastSavedBy(java.lang.String value)
           Returns or sets the name of a last person who modified a presentation.
 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
 

Method Detail

getAppVersion

public final java.lang.String getAppVersion()

Returns the app version. Read-only string.

Specified by:
getAppVersion in interface IDocumentProperties

getNameOfApplication

public java.lang.String getNameOfApplication()

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

Specified by:
getNameOfApplication in interface IDocumentProperties

setNameOfApplication

public 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 java.lang.String getCompany()

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

Specified by:
getCompany in interface IDocumentProperties

setCompany

public void setCompany(java.lang.String value)

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

Specified by:
setCompany in interface IDocumentProperties

getManager

public java.lang.String getManager()

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

Specified by:
getManager in interface IDocumentProperties

setManager

public void setManager(java.lang.String value)

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

Specified by:
setManager in interface IDocumentProperties

getPresentationFormat

public java.lang.String getPresentationFormat()

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

Specified by:
getPresentationFormat in interface IDocumentProperties

setPresentationFormat

public 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 bool.

Specified by:
getSharedDoc in interface IDocumentProperties

setSharedDoc

public final void setSharedDoc(boolean value)

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

Specified by:
setSharedDoc in interface IDocumentProperties

getApplicationTemplate

public java.lang.String getApplicationTemplate()

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

Specified by:
getApplicationTemplate in interface IDocumentProperties

setApplicationTemplate

public 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 double getTotalEditingTime()

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

Specified by:
getTotalEditingTime in interface IDocumentProperties

setTotalEditingTime

public void setTotalEditingTime(double value)

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

Specified by:
setTotalEditingTime in interface IDocumentProperties

getTitle

public java.lang.String getTitle()

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

Specified by:
getTitle in interface IDocumentProperties

setTitle

public 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 java.lang.String getSubject()

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

Specified by:
getSubject in interface IDocumentProperties

setSubject

public 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 java.lang.String getAuthor()

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

Specified by:
getAuthor in interface IDocumentProperties

setAuthor

public 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 java.lang.String getKeywords()

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

Specified by:
getKeywords in interface IDocumentProperties

setKeywords

public 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 java.lang.String getComments()

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

Specified by:
getComments in interface IDocumentProperties

setComments

public 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 java.lang.String getCategory()

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

Specified by:
getCategory in interface IDocumentProperties

setCategory

public 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 java.util.Date getCreatedTime()

Returns or sets the date when a presentation was created. Read/write DateTime.

Specified by:
getCreatedTime in interface IDocumentProperties

getLastSavedTime

public java.util.Date getLastSavedTime()

Returns or sets the date when a presentation was modified last time. Read/write DateTime.

Specified by:
getLastSavedTime in interface IDocumentProperties

getLastPrinted

public java.util.Date getLastPrinted()

Returns or sets the date when a presentation was printed last time. Read/write DateTime.

Specified by:
getLastPrinted in interface IDocumentProperties

getLastSavedBy

public 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 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 int getRevisionNumber()

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

Specified by:
getRevisionNumber in interface IDocumentProperties

setRevisionNumber

public void setRevisionNumber(int value)

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

Specified by:
setRevisionNumber in interface IDocumentProperties

getContentStatus

public java.lang.String getContentStatus()

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

Specified by:
getContentStatus in interface IDocumentProperties

setContentStatus

public 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 java.lang.String getContentType()

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

Specified by:
getContentType in interface IDocumentProperties

setContentType

public 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 java.lang.String getHyperlinkBase()

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

Specified by:
getHyperlinkBase in interface IDocumentProperties

setHyperlinkBase

public void setHyperlinkBase(java.lang.String value)

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

Specified by:
setHyperlinkBase in interface IDocumentProperties

getCount

@Deprecated
public int getCount()
Deprecated. 

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

Specified by:
getCount in interface IDocumentProperties

getCountOfCustomProperties

public int getCountOfCustomProperties()

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

Specified by:
getCountOfCustomProperties in interface IDocumentProperties

getPropertyName

@Deprecated
public java.lang.String getPropertyName(int index)
Deprecated. 

Return a custom property name at the specified index.

Specified by:
getPropertyName 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.

getCustomPropertyName

public 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.

remove

@Deprecated
public boolean remove(java.lang.String name)
Deprecated. 

Remove a custom property associated with a specified name.

Specified by:
remove in interface IDocumentProperties
Parameters:
name - Name of a custom property to remove.
Returns:
Return true if a property was removed, false overwise.

removeCustomProperty

public 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.

contains

@Deprecated
public boolean contains(java.lang.String name)
Deprecated. 

Check presents of a custom property with a specified name.

Specified by:
contains in interface IDocumentProperties
Parameters:
name - Name of a custom property to check.
Returns:
Return true if property exists, false overwise.

containsCustomProperty

public 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 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>string</b>, <b>bool</b> or <b>DateTime</b>.

Specified by:
get_Item in interface IDocumentProperties

set_Item

public 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>string</b>, <b>bool</b> or <b>DateTime</b>.

Specified by:
set_Item in interface IDocumentProperties

getCustomPropertyValue

public void getCustomPropertyValue(java.lang.String name,
                                   boolean[] value)
Description copied from interface: IDocumentProperties

Gets a named boolean value from the custom properties.

Name of the custom property to get Custom property value

Specified by:
getCustomPropertyValue in interface IDocumentProperties

getCustomPropertyValue

public void getCustomPropertyValue(java.lang.String name,
                                   int[] value)
Description copied from interface: IDocumentProperties

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 void getCustomPropertyValue(java.lang.String name,
                                   java.util.Date[] value)
Description copied from interface: IDocumentProperties

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 void getCustomPropertyValue(java.lang.String name,
                                   java.lang.String[] value)
Description copied from interface: IDocumentProperties

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 void getCustomPropertyValue(java.lang.String name,
                                   float[] value)
Description copied from interface: IDocumentProperties

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 void getCustomPropertyValue(java.lang.String name,
                                   double[] value)
Description copied from interface: IDocumentProperties

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 void setCustomPropertyValue(java.lang.String name,
                                   boolean value)
Description copied from interface: IDocumentProperties

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 void setCustomPropertyValue(java.lang.String name,
                                   int value)
Description copied from interface: IDocumentProperties

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 void setCustomPropertyValue(java.lang.String name,
                                   java.util.Date value)
Description copied from interface: IDocumentProperties

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 void setCustomPropertyValue(java.lang.String name,
                                   java.lang.String value)
Description copied from interface: IDocumentProperties

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 void setCustomPropertyValue(java.lang.String name,
                                   float value)
Description copied from interface: IDocumentProperties

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 void setCustomPropertyValue(java.lang.String name,
                                   double value)
Description copied from interface: IDocumentProperties

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 void clearCustomProperties()
Description copied from interface: IDocumentProperties

/ Removes all custom properties.

Specified by:
clearCustomProperties in interface IDocumentProperties

clearBuiltInProperties

public void clearBuiltInProperties()
Description copied from interface: IDocumentProperties

/ Clears and sets default values for all builtIn properties.

Specified by:
clearBuiltInProperties in interface IDocumentProperties


Copyright © Copyright 2004-2016 Aspose Pty Ltd. All Rights Reserved.