Options Dialog

From Apache OpenOffice Wiki
Jump to: navigation, search

Extensions can add options pages to OpenOffice.org's options dialog. They should not create their own menu or menu entries for the sole purpose of configuring the extension. This is what the options dialog is for.

It is also possible to start an options dialog from within the Extension Manager on behalf of a particular extensions. An options page represents a child window that is displayed within the options dialog. An extension can provide multiple options pages. It can determine that they can be added to already existing nodes, such as “OpenOffice.org Writer” or “Internet Settings”. It is also possible to create completely new nodes.

The specification for this feature can be found at: http://specs.openoffice.org/appwide/packagemanager/options_dialog_for_extensions.odt

In the following paragraphs we will show what has to be done in order to add options pages to an extension. Along the way we will go into some details where necessary. It is assumed that the reader has already knowledge about extension programming and that he or she knows how the OpenOffice.org's registry (including xcs and xcu files) works.

A note about writing some terms. When we refer to elements from the configuration schema of OpenOffice.org then we use the respective uppercase names, for example Node, Module. The plural will expressed by adding a pipe symbol an the respective postfix, for example Nodes, Modules.

Available samples

Content on this page is licensed under the Public Documentation License (PDL).
Personal tools
In other languages