LibreOffice: XProtectable Interface Reference

LibreOffice LibreOffice 7.5 SDK API Reference

Loading...
Searching...
No Matches
Public Member Functions | List of all members
XProtectable Interface Referencepublished

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

Inheritance diagram for XProtectable:

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

## 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

  aPassword | a string to specify new password.

## ◆ unprotect()

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

removes the protection.

Parameters

  aPassword | a string to match with the current password.

Exceptions

  com::sun::star::lang::IllegalArgumentException | if invalid password is specified.

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

- com/sun/star/util/XProtectable.idl