1*cdf0e10cSrcweir/************************************************************************* 2*cdf0e10cSrcweir * 3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4*cdf0e10cSrcweir * 5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates. 6*cdf0e10cSrcweir * 7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite 8*cdf0e10cSrcweir * 9*cdf0e10cSrcweir * This file is part of OpenOffice.org. 10*cdf0e10cSrcweir * 11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify 12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3 13*cdf0e10cSrcweir * only, as published by the Free Software Foundation. 14*cdf0e10cSrcweir * 15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful, 16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of 17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details 19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code). 20*cdf0e10cSrcweir * 21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License 22*cdf0e10cSrcweir * version 3 along with OpenOffice.org. If not, see 23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html> 24*cdf0e10cSrcweir * for a copy of the LGPLv3 License. 25*cdf0e10cSrcweir * 26*cdf0e10cSrcweir ************************************************************************/ 27*cdf0e10cSrcweir 28*cdf0e10cSrcweir#ifndef __ooo_vba_XDocumentProperties_idl__ 29*cdf0e10cSrcweir#define __ooo_vba_XDocumentProperties_idl__ 30*cdf0e10cSrcweir 31*cdf0e10cSrcweir#ifndef __com_sun_star_script_BasicErrorException_idl__ 32*cdf0e10cSrcweir#include <com/sun/star/script/BasicErrorException.idl> 33*cdf0e10cSrcweir#endif 34*cdf0e10cSrcweir#ifndef __ooo_vba_XHelperInterface_idl__ 35*cdf0e10cSrcweir#include <ooo/vba/XHelperInterface.idl> 36*cdf0e10cSrcweir#endif 37*cdf0e10cSrcweir#ifndef __ooo_vba_XCollection_idl__ 38*cdf0e10cSrcweir#include <ooo/vba/XCollection.idl> 39*cdf0e10cSrcweir#endif 40*cdf0e10cSrcweir 41*cdf0e10cSrcweirmodule ooo { module vba { 42*cdf0e10cSrcweirinterface XDocumentProperty; 43*cdf0e10cSrcweirinterface XDocumentProperties 44*cdf0e10cSrcweir{ 45*cdf0e10cSrcweir interface XCollection; 46*cdf0e10cSrcweir /** Creates a new custom document property. 47*cdf0e10cSrcweir * You can only add a new document property to the custom DocumentProperties collection. Depending on value of 48*cdf0e10cSrcweir * boolean LinkSource, either (False) Value or (True) LinkSource must be provided. 49*cdf0e10cSrcweir * @param Name (Required String. The name of the property. 50*cdf0e10cSrcweir * @param LinkToContent Specifies whether the property is linked to the contents of the container document. If this argument is True, the LinkSource argument is required; if it's False, the value argument is required. 51*cdf0e10cSrcweir * @param Type The data type of the property. Can be one of the following MsoDocProperties constants: 52*cdf0e10cSrcweir * msoPropertyTypeBoolean, msoPropertyTypeDate, msoPropertyTypeFloat, msoPropertyTypeNumber, or msoPropertyTypeString. 53*cdf0e10cSrcweir * @param Value The value of the property, if it's not linked to the contents of the container document. 54*cdf0e10cSrcweir * The value is converted to match the data type specified by the type argument, if it can't be converted, an error occurs. 55*cdf0e10cSrcweir * If LinkToContent is True, the Value argument is ignored and the new document property is assigned a default value 56*cdf0e10cSrcweir * until the linked property values are updated by the container application (usually when the document is saved). 57*cdf0e10cSrcweir * @param LinkSource Ignored if LinkToContent is False. The source of the linked property. The container application determines 58*cdf0e10cSrcweir * what types of source linking you can use. 59*cdf0e10cSrcweir */ 60*cdf0e10cSrcweir XDocumentProperty Add([in] string Name, [in] boolean LinkToContent, [in] /* MsoDocProperties */ byte Type, [in] any Value, 61*cdf0e10cSrcweir [in] /*optional*/ any LinkSource) 62*cdf0e10cSrcweir raises (com::sun::star::script::BasicErrorException); 63*cdf0e10cSrcweir}; 64*cdf0e10cSrcweir 65*cdf0e10cSrcweir}; }; 66*cdf0e10cSrcweir 67*cdf0e10cSrcweir#endif 68*cdf0e10cSrcweir 69