ooodev.adapter.script.storage_based_library_container_partial module

class ooodev.adapter.script.storage_based_library_container_partial.StorageBasedLibraryContainerPartial(component, interface=com.sun.star.script.XStorageBasedLibraryContainer)[source]

Bases: PersistentLibraryContainerPartial

Partial class for XStorageBasedLibraryContainer.

Parameters:

  • component (XStorageBasedLibraryContainer) –

  • interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.script.XStorageBasedLibraryContainer)[source]

Constructor

Parameters:

  • component (XStorageBasedLibraryContainer) – UNO Component that implements com.sun.star.script.XStorageBasedLibraryContainer interface.

  • interface (UnoInterface, optional) – The interface to be validated. Defaults to XStorageBasedLibraryContainer.

Return type:

None

store_libraries_to_storage(root_storage)[source]

Stores the libraries to a storage other than the current container storage

Note that the library container is not automatically associated with the new root storage. Instead, you need to manually set the RootStorage attribute afterwards. This separation allows for Save-To as well Save-As operations.

Raises:

  • com.sun.star.lang.IllegalArgumentException – IllegalArgumentException

  • com.sun.star.lang.WrappedTargetException – WrappedTargetException

Return type:

None

Parameters:

root_storage (com.sun.star.embed.XStorage) –

property root_storage: com.sun.star.embed.XStorage

Denotes the root storage associated with the container.

Effectively, this attribute is a typed version of XPersistentLibraryContainer.RootLocation, it’s guaranteed that at every time, XPersistentLibraryContainer.RootLocation and root_storage have the same value.

You should only set this attribute to a new value if you previously called storeLibrariesToStorage with the same storage. Setting this attribute to a storage into which the container has not been stored previously might result in unexpected behavior.

Return type:

XStorage