com.aspose.slides

Class PresentationInfo

java.lang.Object

com.aspose.slides.PresentationInfo

All Implemented Interfaces:

IPresentationInfo

public final class PresentationInfo
extends java.lang.Object
implements IPresentationInfo

Information about presentation file

Method Summary

Modifier and Type	Method and Description
boolean	checkPassword(java.lang.String password) Checks whether a password is correct for a presentation protected with open password.
boolean	checkWriteProtection(java.lang.String password) Checks whether a password to modify is correct for a write protected presentation.
int	getLoadFormat() Gets format of the binded presentation.
boolean	isEncrypted() Gets True if binded presentation is encrypted, otherwise False.
boolean	isPasswordProtected() Gets a value that indicates whether a binded presentation is protected by a password to open.
byte	isWriteProtected() Gets a value that indicates whether a binded presentation is write protected.
IDocumentProperties	readDocumentProperties() Gets document properties of binded presentation.
void	updateDocumentProperties(IDocumentProperties documentProperties) Updates properties of binded presentation.
void	writeBindedPresentation(java.io.OutputStream stream) Writes binded presentation to stream.
void	writeBindedPresentation(java.lang.String file) Writes binded presentation to file.

Methods inherited from class java.lang.Object

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

Method Detail

isEncrypted

public final boolean isEncrypted()

Gets True if binded presentation is encrypted, otherwise False. Read-only boolean.

Specified by:

isEncrypted in interface IPresentationInfo

isPasswordProtected

public final boolean isPasswordProtected()

Gets a value that indicates whether a binded presentation is protected by a password to open.

 
 IPresentationInfo info = PresentationFactory.getInstance().getPresentationInfo(presentationFilePath);
 if (info.isPasswordProtected())
 {
     System.out.println("The presentation '" + presentationFilePath + "' is protected by password to open.");
 }
 
 

Specified by:

isPasswordProtected in interface IPresentationInfo

isWriteProtected

public final byte isWriteProtected()

Gets a value that indicates whether a binded presentation is write protected.

 
 IPresentationInfo info = PresentationFactory.getInstance().getPresentationInfo(presentationFilePath);
 if (info.isWriteProtected() == NullableBool.True)
 {
     System.out.println("The presentation '" + presentationFilePath + "' is protected by password to open.");
 }
 
 

If the presentation is protected by a password to open, the property value equals NotDefined.

Specified by:

isWriteProtected in interface IPresentationInfo

getLoadFormat

public final int getLoadFormat()

Gets format of the binded presentation. Read-only LoadFormat.

Specified by:

getLoadFormat in interface IPresentationInfo

checkPassword

public final boolean checkPassword(java.lang.String password)

Checks whether a password is correct for a presentation protected with open password.

 
 IPresentationInfo info = PresentationFactory.getInstance().getPresentationInfo(presentationFilePath);
 boolean isPasswordCorrect = info.checkPassword("my_password");
 
 

Specified by:

checkPassword in interface IPresentationInfo

Parameters:

password - The password to check.

When the password is null or empty, this method returns false.

Returns:

True if the presentation is protected with open password and the password is correct and false otherwise.

Throws:

com.aspose.ms.System.InvalidOperationException - if an unknown presentation format is encountered.

com.aspose.ms.System.NotSupportedException - if format is not supported to check passwords.

checkWriteProtection

public final boolean checkWriteProtection(java.lang.String password)

Checks whether a password to modify is correct for a write protected presentation.

 
 IPresentationInfo info = PresentationFactory.getInstance().getPresentationInfo(presentationFilePath);
 if (info.isWriteProtected() == NullableBool.True)
 {
     boolean isWriteProtectedByPassword = info.checkWriteProtection("my_password");
 }
 
 

Specified by:

checkWriteProtection in interface IPresentationInfo

Parameters:

password - The password to check.

1. You should check the (isWriteProtected()) property before calling this method. 2. When password is null or empty, this method returns false.

Returns:

True if the presentation is write protected and the password is correct. False otherwise.

Throws:

com.aspose.ms.System.InvalidOperationException - If a presentation is protected by a password to open or format does not support write protection

readDocumentProperties

public final IDocumentProperties readDocumentProperties()

Gets document properties of binded presentation.

Specified by:

readDocumentProperties in interface IPresentationInfo

Returns:

Document properties IDocumentProperties

updateDocumentProperties

public final void updateDocumentProperties(IDocumentProperties documentProperties)

Updates properties of binded presentation.

 This sample shows how to call the updateDocumentProperties(IDocumentProperties) method to
 update the document properties returned by call of the readDocumentProperties() method.
 
 IPresentationInfo info = PresentationFactory.getInstance().getPresentationInfo("pres.pptx");
 IDocumentProperties props = info.readDocumentProperties();
 props.setSubject("New subject");
 props.setLastSavedTime(Calendar.getInstance().getTime());
 info.updateDocumentProperties(props);
 info.writeBindedPresentation("new_pres.pptx");
 
 

Specified by:

updateDocumentProperties in interface IPresentationInfo

Parameters:

documentProperties - Document properties IDocumentProperties

writeBindedPresentation

public final void writeBindedPresentation(java.io.OutputStream stream)

Writes binded presentation to stream.

Specified by:

writeBindedPresentation in interface IPresentationInfo

Parameters:

stream - The stream must be seekable and writable.

writeBindedPresentation

public final void writeBindedPresentation(java.lang.String file)

Writes binded presentation to file.

Specified by:

writeBindedPresentation in interface IPresentationInfo

Parameters:

file - Presentation file.