oovbaapi/ooo/vba/XDocumentProperties.idl

   1 /*
   2  * This file is part of the LibreOffice project.
   3  *
   4  * This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this
   6  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   7  *
   8  * This file incorporates work covered by the following license notice:
   9  *
  10  *   Licensed to the Apache Software Foundation (ASF) under one or more
  11  *   contributor license agreements. See the NOTICE file distributed
  12  *   with this work for additional information regarding copyright
  13  *   ownership. The ASF licenses this file to you under the Apache
  14  *   License, Version 2.0 (the "License"); you may not use this file
  15  *   except in compliance with the License. You may obtain a copy of
  16  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  17  */
  18
  19 #ifndef __ooo_vba_XDocumentProperties_idl__
  20 #define __ooo_vba_XDocumentProperties_idl__
  21
  22 #include <com/sun/star/script/BasicErrorException.idl>
  23 #include <ooo/vba/XHelperInterface.idl>
  24 #include <ooo/vba/XCollection.idl>
  25
  26 module ooo { module vba {
  27 interface XDocumentProperty;
  28 interface XDocumentProperties
  29 {
  30     interface XCollection;
  31     /** Creates a new custom document property.
  32      * You can only add a new document property to the custom DocumentProperties collection. Depending on value of
  33      * boolean LinkSource, either (False) Value or (True) LinkSource must be provided.
  34      * @param Name (Required String. The name of the property.
  35      * @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.
  36      * @param Type The data type of the property. Can be one of the following MsoDocProperties constants:
  37      * msoPropertyTypeBoolean, msoPropertyTypeDate, msoPropertyTypeFloat, msoPropertyTypeNumber, or msoPropertyTypeString.
  38      * @param Value The value of the property, if it's not linked to the contents of the container document.
  39      * The value is converted to match the data type specified by the type argument, if it can't be converted, an error occurs.
  40      * If LinkToContent is True, the Value argument is ignored and the new document property is assigned a default value
  41      * until the linked property values are updated by the container application (usually when the document is saved).
  42      * @param LinkSource Ignored if LinkToContent is False. The source of the linked property. The container application determines
  43      * what types of source linking you can use.
  44      */
  45     XDocumentProperty Add([in] string Name, [in] boolean LinkToContent, [in] /* MsoDocProperties */ byte Type, [in] any Value,
  46         [in] /*optional*/ any LinkSource)
  47         raises (com::sun::star::script::BasicErrorException);
  48 };
  49
  50 }; };
  51
  52 #endif
  53