LibreOffice
LibreOffice 24.2 SDK API Reference
Public Member Functions | List of all members
XProtectable Interface Referencepublished

makes it possible to protect objects from modifications. More...

import"XProtectable.idl";

Inheritance diagram for XProtectable:
XInterface Spreadsheet SpreadsheetDocument

Public Member Functions

void protect ([in] string aPassword)
 activates the protection. More...
 
void unprotect ([in] string aPassword) raises ( com::sun::star::lang::IllegalArgumentException )
 removes the protection. More...
 
boolean isProtected ()
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

makes it possible to protect objects from modifications.

Developers Guide
Spreadsheet Documents - Protecting Spreadsheets

Member Function Documentation

◆ isProtected()

boolean isProtected ( )
Returns
the current state of protection.

◆ protect()

void protect ( [in] string  aPassword)

activates the protection.

Parameters
aPassworda string to specify new password.

◆ unprotect()

void unprotect ( [in] string  aPassword)
raises (com::sun::star::lang::IllegalArgumentException
)

removes the protection.

Parameters
aPassworda string to match with the current password.
Exceptions
com::sun::star::lang::IllegalArgumentExceptionif invalid password is specified.

The documentation for this interface was generated from the following file: