Interface XAutoTextContainer

Devguide

Index

Methods' Summary

Attributes' Summary

Methods' Details

Attributes' Details

:: com :: sun :: star :: text ::

interface XAutoTextContainer

Base Interfaces

XAutoTextContainer
┗ ::com::sun::star::container::XNameAccess
   ┗ ::com::sun::star::container::XElementAccess

::com::sun::star::container::XNameAccess

(referenced interface's summary:): is used to access named objects within a container.

Description: handles blocks of AutoTextEntry.
See also: AutoTextContainer

Methods' Summary
insertNewByName	creates a new AutoText group.
removeByName	deletes the specified AutoText group.

Methods' Details

insertNewByName

XAutoTextGroup
insertNewByName(	[in] string	aGroupName )
raises(	::com::sun::star::lang::IllegalArgumentException, ::com::sun::star::container::ElementExistException );

Description

creates a new AutoText group.

Parameter aGroupName

the name of the AutoTextContainer

The name must follow the pattern groupname*pathid, where:

groupname should contain only alphanumeric characters (A-Za-z0-9), underscore (_) or space (0x20)
an asterisk (*) delimiter separates the group name from the path identifier
pathid is a number (0 or 1) identifying the directory where the AutoText file is stored. Paths are stored in the Office configuration and accessed through ::com::sun::star::util::PathSettings::AutoText.
- 0 indicates the path of the Office Basis layer
- 1 indicates the path of the user directory

If only groupname is specified, the path defaults to 0, the Office Basis layer.
Note that in some systems the user may lack of write access to the Office Basis directory.

Example

standard*0
the "standard" AutoTextGroup in the Office Basis layer
template
the "template" AutoTextGroup in the Office Basis layer
mytexts*1
the "mytexts" AutoTextGroup in the user directory

removeByName

void
removeByName(	[in] string	aGroupName )
raises(	::com::sun::star::container::NoSuchElementException );

Description: deletes the specified AutoText group.
Parameter aGroupName: see the documentation for XAutoTextContainer::insertNewByName()

Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

API

SDK

Tips ‘n’ Tricks

Miscellaneous