DocumentProperties

DocumentProperties class

Represents properties of a presentation.

DocumentProperties

NameDescription
DocumentProperties()Initializes new instance of class DocumentProperties.

Returns: DocumentProperties


clearBuiltInProperties

NameDescription
clearBuiltInProperties ()Clears and sets default values for all builtIn properties.

Returns: void


clearCustomProperties

NameDescription
clearCustomProperties ()Removes all custom properties.

Returns: void


cloneT

NameDescription
cloneT ()Clones current object

Returns: DocumentProperties


containsCustomProperty

NameDescription
containsCustomProperty (String)Check presents of a custom property with a specified name.

Parameters:

NameTypeDescription
nameStringName of a custom property to check.

Returns: boolean


deepClone

NameDescription
deepClone ()Clones current object

Returns: Object


getAppVersion

NameDescription
getAppVersion ()Returns the app version. Read-only String.

Returns: String


getApplicationTemplate

NameDescription
getApplicationTemplate ()Returns or sets the template of a application. Read/write String.

Returns: String


getAuthor

NameDescription
getAuthor ()Returns or sets the author of a presentation. Read/write String.

Returns: String


getCategory

NameDescription
getCategory ()Returns or sets the category of a presentation. Read/write String.

Returns: String


getComments

NameDescription
getComments ()Returns or sets the comments of a presentation. Read/write String.

Returns: String


getCompany

NameDescription
getCompany ()Returns or sets the company property. Read/write String.

Returns: String


getContentStatus

NameDescription
getContentStatus ()Returns or sets the content status of a presentation. Read/write String.

Returns: String


getContentType

NameDescription
getContentType ()Returns or sets the content type of a presentation. Read/write String.

Returns: String


getCountOfCustomProperties

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

Returns: int


getCreatedTime

NameDescription
getCreatedTime ()Returns the date a presentation was created. Values are in UTC. Read/write java.util.Date.

Returns: Date


getCustomPropertyName

NameDescription
getCustomPropertyName (int)Return a custom property name at the specified index.

Parameters:

NameTypeDescription
indexintThe zero-based index of a custom property to get.

Returns: String

Exception

ErrorCondition
com.aspose.ms.System.ArgumentOutOfRangeExceptionIndex is less than zero. Index is equal to or greater than Count.

getCustomPropertyValue

NameDescription
getCustomPropertyValue (String, boolean[])Gets a named boolean value from the custom properties.

Parameters:

NameTypeDescription
nameStringName of the custom property to get
valueboolean[]Custom property value

Returns: void


getCustomPropertyValue

NameDescription
getCustomPropertyValue (String, int[])Gets a named integer value from the custom properties.

Parameters:

NameTypeDescription
nameStringName of the custom property to get
valueint[]Custom property value

Returns: void


getCustomPropertyValue

NameDescription
getCustomPropertyValue (String, java.util.Date[])Gets a named DateTime value from the custom properties.

Parameters:

NameTypeDescription
nameStringName of the custom property to get
valuejava.util.Date[]Custom property value

Returns: void


getCustomPropertyValue

NameDescription
getCustomPropertyValue (String, java.lang.String[])Gets a named string value from the custom properties.

Parameters:

NameTypeDescription
nameStringName of the custom property to get
valuejava.lang.String[]Custom property value

Returns: void


getCustomPropertyValue

NameDescription
getCustomPropertyValue (String, float[])Gets a named float value from the custom properties.

Parameters:

NameTypeDescription
nameStringName of the custom property to get
valuefloat[]Custom property value

Returns: void


getCustomPropertyValue

NameDescription
getCustomPropertyValue (String, double[])Gets a named double value from the custom properties.

Parameters:

NameTypeDescription
nameStringName of the custom property to get.
valuedouble[]Custom property value

Returns: void


getHyperlinkBase

NameDescription
getHyperlinkBase ()Returns or sets the HyperlinkBase document property. Read/write String.

Returns: String


getKeywords

NameDescription
getKeywords ()Returns or sets the keywords of a presentation. Read/write String.

Returns: String


getLastPrinted

NameDescription
getLastPrinted ()Returns the date when a presentation was printed last time. Read/write java.util.Date.

Returns: Date


getLastSavedBy

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

Returns: String


getLastSavedTime

NameDescription
getLastSavedTime ()Returns the date a presentation was last modified. Values are in UTC. 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: Date


getManager

NameDescription
getManager ()Returns or sets the manager property. Read/write String.

Returns: String


getNameOfApplication

NameDescription
getNameOfApplication ()Returns or sets the name of the application. Read/write String.

Returns: String


getPresentationFormat

NameDescription
getPresentationFormat ()Returns or sets the intended format of a presentation. Read/write String.

Returns: String


getRevisionNumber

NameDescription
getRevisionNumber ()Returns or sets the presentation revision number. Read/write int.

Returns: int


getSharedDoc

NameDescription
getSharedDoc ()Determines whether the presentation is shared between multiple people. Read/write boolean.

Returns: boolean


getSubject

NameDescription
getSubject ()Returns or sets the subject of a presentation. Read/write String.

Returns: String


getTitle

NameDescription
getTitle ()Returns or sets the title of a presentation. Read/write String.

Returns: String


getTotalEditingTime

NameDescription
getTotalEditingTime ()Total editing time of a presentation. Read/write double.

Returns: double


get_Item

NameDescription
get_Item (String)Returns or sets the custom property associated with a specified name. Read/write Object. Value can be int, float, String, boolean or Date.

Returns: Object


removeCustomProperty

NameDescription
removeCustomProperty (String)Remove a custom property associated with a specified name.

Parameters:

NameTypeDescription
nameStringName of a custom property to remove.

Returns: boolean


setApplicationTemplate

NameDescription
setApplicationTemplate (String)Returns or sets the template of a application. Read/write String.

Returns: void


setAuthor

NameDescription
setAuthor (String)Returns or sets the author of a presentation. Read/write String.

Returns: void


setCategory

NameDescription
setCategory (String)Returns or sets the category of a presentation. Read/write String.

Returns: void


setComments

NameDescription
setComments (String)Returns or sets the comments of a presentation. Read/write String.

Returns: void


setCompany

NameDescription
setCompany (String)Returns or sets the company property. Read/write String.

Returns: void


setContentStatus

NameDescription
setContentStatus (String)Returns or sets the content status of a presentation. Read/write String.

Returns: void


setContentType

NameDescription
setContentType (String)Returns or sets the content type of a presentation. Read/write String.

Returns: void


setCreatedTime

NameDescription
setCreatedTime (Date)Returns the date a presentation was created. Values are in UTC. Read/write java.util.Date.

Returns: void


setCustomPropertyValue

NameDescription
setCustomPropertyValue (String, boolean)Sets a named boolean custom property.

Parameters:

NameTypeDescription
nameStringName of the custom property to set
valuebooleanCustom property value

Returns: void


setCustomPropertyValue

NameDescription
setCustomPropertyValue (String, int)Sets a named integer custom property.

Parameters:

NameTypeDescription
nameStringName of the custom property to set
valueintCustom property value

Returns: void


setCustomPropertyValue

NameDescription
setCustomPropertyValue (String, Date)Sets a named DateTime custom property.

Parameters:

NameTypeDescription
nameStringName of the custom property to set
valueDateCustom property value

Returns: void


setCustomPropertyValue

NameDescription
setCustomPropertyValue (String, String)Sets a named string custom property.

Parameters:

NameTypeDescription
nameStringName of the custom property to set
valueStringCustom property value

Returns: void


setCustomPropertyValue

NameDescription
setCustomPropertyValue (String, float)Sets a named float custom property.

Parameters:

NameTypeDescription
nameStringName of the custom property to set
valuefloatCustom property value

Returns: void


setCustomPropertyValue

NameDescription
setCustomPropertyValue (String, double)Sets a named double custom property.

Parameters:

NameTypeDescription
nameStringName of the custom property to set
valuedoubleCustom property value

Returns: void


setHyperlinkBase

NameDescription
setHyperlinkBase (String)Returns or sets the HyperlinkBase document property. Read/write String.

Returns: void


setKeywords

NameDescription
setKeywords (String)Returns or sets the keywords of a presentation. Read/write String.

Returns: void


setLastPrinted

NameDescription
setLastPrinted (Date)Returns the date when a presentation was printed last time. Read/write java.util.Date.

Returns: void


setLastSavedBy

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

Returns: void


setLastSavedTime

NameDescription
setLastSavedTime (Date)Returns the date a presentation was last modified. Values are in UTC. 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: void


setManager

NameDescription
setManager (String)Returns or sets the manager property. Read/write String.

Returns: void


setNameOfApplication

NameDescription
setNameOfApplication (String)Returns or sets the name of the application. Read/write String.

Returns: void


setPresentationFormat

NameDescription
setPresentationFormat (String)Returns or sets the intended format of a presentation. Read/write String.

Returns: void


setRevisionNumber

NameDescription
setRevisionNumber (int)Returns or sets the presentation revision number. Read/write int.

Returns: void


setSharedDoc

NameDescription
setSharedDoc (boolean)Determines whether the presentation is shared between multiple people. Read/write boolean.

Returns: void


setSubject

NameDescription
setSubject (String)Returns or sets the subject of a presentation. Read/write String.

Returns: void


setTitle

NameDescription
setTitle (String)Returns or sets the title of a presentation. Read/write String.

Returns: void


setTotalEditingTime

NameDescription
setTotalEditingTime (double)Total editing time of a presentation. Read/write double.

Returns: void


set_Item

NameDescription
set_Item (String, Object)Returns or sets the custom property associated with a specified name. Read/write Object. Value can be int, float, String, boolean or Date.

Returns: void