Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous


:: com :: sun :: star :: document ::

interface XActionLockable
Description
makes it possible to prevent object internal updates for a certain period to be able to quickly change multiple parts of the objects, where the updates would invalidate each other, anyway.
Developers Guide
Spreadsheets - Protecting Spreadsheets

Methods' Summary
isActionLocked  
addActionLock increments the lock count of the object by one.  
removeActionLock decrements the lock count of the object by one.  
setActionLocks sets the locking level.  
resetActionLocks resets the locking level.  
Methods' Details
isActionLocked
boolean
isActionLocked();

Returns
true if at least one lock exists.
addActionLock
void
addActionLock();

Description
increments the lock count of the object by one.
removeActionLock
void
removeActionLock();

Description
decrements the lock count of the object by one.
setActionLocks
void
setActionLocks( [in] short  nLock );

Description
sets the locking level.

This method is used for debugging purposes. The programming environment can restore the locking after a break of a debug session.

resetActionLocks
short
resetActionLocks();

Description
resets the locking level.

This method is used for debugging purposes. The debugging environment of a programming language can reset the locks to allow refreshing of the view if a breakpoint is reached or step execution is used.

Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache, OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. The Apache feather logo is a trademark of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.