1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski 24*b1cdbd2cSJim Jagielski#ifndef __ooo_vba_XDocumentProperties_idl__ 25*b1cdbd2cSJim Jagielski#define __ooo_vba_XDocumentProperties_idl__ 26*b1cdbd2cSJim Jagielski 27*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_script_BasicErrorException_idl__ 28*b1cdbd2cSJim Jagielski#include <com/sun/star/script/BasicErrorException.idl> 29*b1cdbd2cSJim Jagielski#endif 30*b1cdbd2cSJim Jagielski#ifndef __ooo_vba_XHelperInterface_idl__ 31*b1cdbd2cSJim Jagielski#include <ooo/vba/XHelperInterface.idl> 32*b1cdbd2cSJim Jagielski#endif 33*b1cdbd2cSJim Jagielski#ifndef __ooo_vba_XCollection_idl__ 34*b1cdbd2cSJim Jagielski#include <ooo/vba/XCollection.idl> 35*b1cdbd2cSJim Jagielski#endif 36*b1cdbd2cSJim Jagielski 37*b1cdbd2cSJim Jagielskimodule ooo { module vba { 38*b1cdbd2cSJim Jagielskiinterface XDocumentProperty; 39*b1cdbd2cSJim Jagielskiinterface XDocumentProperties 40*b1cdbd2cSJim Jagielski{ 41*b1cdbd2cSJim Jagielski interface XCollection; 42*b1cdbd2cSJim Jagielski /** Creates a new custom document property. 43*b1cdbd2cSJim Jagielski * You can only add a new document property to the custom DocumentProperties collection. Depending on value of 44*b1cdbd2cSJim Jagielski * boolean LinkSource, either (False) Value or (True) LinkSource must be provided. 45*b1cdbd2cSJim Jagielski * @param Name (Required String. The name of the property. 46*b1cdbd2cSJim Jagielski * @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. 47*b1cdbd2cSJim Jagielski * @param Type The data type of the property. Can be one of the following MsoDocProperties constants: 48*b1cdbd2cSJim Jagielski * msoPropertyTypeBoolean, msoPropertyTypeDate, msoPropertyTypeFloat, msoPropertyTypeNumber, or msoPropertyTypeString. 49*b1cdbd2cSJim Jagielski * @param Value The value of the property, if it's not linked to the contents of the container document. 50*b1cdbd2cSJim Jagielski * The value is converted to match the data type specified by the type argument, if it can't be converted, an error occurs. 51*b1cdbd2cSJim Jagielski * If LinkToContent is True, the Value argument is ignored and the new document property is assigned a default value 52*b1cdbd2cSJim Jagielski * until the linked property values are updated by the container application (usually when the document is saved). 53*b1cdbd2cSJim Jagielski * @param LinkSource Ignored if LinkToContent is False. The source of the linked property. The container application determines 54*b1cdbd2cSJim Jagielski * what types of source linking you can use. 55*b1cdbd2cSJim Jagielski */ 56*b1cdbd2cSJim Jagielski XDocumentProperty Add([in] string Name, [in] boolean LinkToContent, [in] /* MsoDocProperties */ byte Type, [in] any Value, 57*b1cdbd2cSJim Jagielski [in] /*optional*/ any LinkSource) 58*b1cdbd2cSJim Jagielski raises (com::sun::star::script::BasicErrorException); 59*b1cdbd2cSJim Jagielski}; 60*b1cdbd2cSJim Jagielski 61*b1cdbd2cSJim Jagielski}; }; 62*b1cdbd2cSJim Jagielski 63*b1cdbd2cSJim Jagielski#endif 64*b1cdbd2cSJim Jagielski 65