Overview | Module | Use | Devguide | Index

Methods' Summary | Attributes' Summary | Methods' Details | Attributes' Details

:: com :: sun :: star :: frame ::
interface XDocumentTemplates
Description provides a high level API to organize document templates Template information are saved as links to the original content and organized in groups. This data should be persistent and can be updated by calling special method update(). A real implementation of this interface can do that on top of an ucb content provider. Method getContent() force that.

Methods' Summary
getContent | provides access to the root of internal used hierarchy
storeTemplate | creates the template with the given name in the given group using the data from the storable
addTemplate | creates the template with the given name in the given group using the given URL
removeTemplate | remove a template from specified group
renameTemplate | rename a template inside specified group
addGroup | creates a new group
removeGroup | remove an existing group
renameGroup | rename an existing group
update | force an update for internal structures

Methods' Details
getContent
::com::sun::star::ucb::XContent
getContent();
Description provides access to the root of internal used hierarchy This content can be used for accessing the groups directly. Returns the ucb content for template configuration
storeTemplate
boolean
storeTemplate( | [in] string | GroupName,
| [in] string | TemplateName,
| [in] XStorable | Storable );
Description creates the template with the given name in the given group using the data from the storable Parameter GroupName specifies the group Parameter TemplateName specifies the template Parameter Storable specifies the target Returns true if operation was successful false otherwise See also XDocumentTemplates::addTemplate()
addTemplate
boolean
addTemplate( | [in] string | GroupName,
| [in] string | TemplateName,
| [in] string | SourceURL );
Description creates the template with the given name in the given group using the given URL Parameter GroupName specifies the group Parameter TemplateName specifies the template Parameter SourceURL specifies the position of template Returns true if operation was successful false otherwise See also XDocumentTemplates::storeTemplate()
removeTemplate
boolean
removeTemplate( | [in] string | GroupName,
| [in] string | TemplateName );
Description remove a template from specified group Parameter GroupName specifies the group which include the template Parameter TemplateName specifies the template for delete Returns true if operation was successful false otherwise
renameTemplate
boolean
renameTemplate( | [in] string | GroupName,
| [in] string | OldTemplateName,
| [in] string | NewTemplateName );
Description rename a template inside specified group Parameter GroupName specifies the group which include the template Parameter TemplateName specifies the template for renaming Returns true if operation was successful false otherwise
addGroup
boolean
addGroup( | [in] string | GroupName );
Description creates a new group Parameter GroupName the name of the group to be created Returns true if operation was successful false otherwise
removeGroup
boolean
removeGroup( | [in] string | GroupName );
Description remove an existing group Parameter GroupName the name of the group to be removed Returns true if operation was successful false otherwise
renameGroup
boolean
renameGroup( | [in] string | OldGroupName,
| [in] string | NewGroupName );
Description rename an existing group Parameter OldGroupName the old name of the group Parameter NewGroupName the new name of the group Returns true if operation was successful false otherwise
update
void
update();
Description force an update for internal structures Because the templates are well known by links and not as direct content they can be outdated. An update force actualization of that to find wrong links.

Top of Page

Copyright © 2000, 2013 LibreOffice contributors and/or their affiliates. All rights reserved.

LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.

The Document Foundation acknowledges all community members, please find more info at our website.

Privacy Policy | Impressum (Legal Info) | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (LGPLv3). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our trademark policy.