LibreOffice LibreOffice 26.2 SDK API Reference

XDocumentProperties.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20
21
22module com { module sun { module star { module document {
23
43published interface XDocumentProperties
44{
48 [attribute] string Author;
49
60 [attribute] string Generator;
61
65 [attribute] com::sun::star::util::DateTime CreationDate;
66
70 [attribute] string Title;
71
75 [attribute] string Subject;
76
83 [attribute] string Description;
84
88 [attribute] sequence< string > Keywords;
89
93 [attribute] com::sun::star::lang::Locale Language;
94
98 [attribute] string ModifiedBy;
99
106 [attribute] com::sun::star::util::DateTime ModificationDate;
107
111 [attribute] string PrintedBy;
112
119 [attribute] com::sun::star::util::DateTime PrintDate;
120
128 [attribute] string TemplateName;
129
137 [attribute] string TemplateURL;
138
143 [attribute] com::sun::star::util::DateTime TemplateDate;
144
159 [attribute] string AutoloadURL;
160
177 [attribute] long AutoloadSecs {
178 set raises ( com::sun::star::lang::IllegalArgumentException );
179 };
180
188 [attribute] string DefaultTarget;
189
196 [attribute]
197 sequence< com::sun::star::beans::NamedValue > DocumentStatistics;
198
207 [attribute] short EditingCycles {
208 set raises ( com::sun::star::lang::IllegalArgumentException );
209 };
210
219 [attribute] long EditingDuration {
220 set raises ( com::sun::star::lang::IllegalArgumentException );
221 };
222
245 void resetUserData( [in] string Author );
246
255 com::sun::star::beans::XPropertyContainer getUserDefinedProperties();
256
285 void loadFromStorage( [in] com::sun::star::embed::XStorage Storage,
286 [in] sequence < com::sun::star::beans::PropertyValue > Medium )
287 raises( com::sun::star::lang::IllegalArgumentException,
288 com::sun::star::io::WrongFormatException,
289 com::sun::star::lang::WrappedTargetException,
290 com::sun::star::io::IOException );
291
314 void loadFromMedium( [in] string URL,
315 [in] sequence < com::sun::star::beans::PropertyValue > Medium )
316 raises( com::sun::star::io::WrongFormatException,
317 com::sun::star::lang::WrappedTargetException,
318 com::sun::star::io::IOException );
319
349 void storeToStorage( [in] com::sun::star::embed::XStorage Storage,
350 [in] sequence < com::sun::star::beans::PropertyValue > Medium )
351 raises( com::sun::star::lang::IllegalArgumentException,
352 com::sun::star::lang::WrappedTargetException,
353 com::sun::star::io::IOException );
354
375 void storeToMedium( [in] string URL,
376 [in] sequence < com::sun::star::beans::PropertyValue > Medium )
377 raises( com::sun::star::lang::WrappedTargetException,
378 com::sun::star::io::IOException );
379};
380
381
382}; }; }; };
383
384/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::io::IOException
is thrown when an input or output error has occurred.
Definition: IOException.idl:27
com::sun::star::io::WrongFormatException
is thrown when inconsistent data comes up while reading a complex data type (string or object).
Definition: WrongFormatException.idl:28
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
com::sun::star::lang::WrappedTargetException
This is a checked exception that wraps an exception thrown by the original target.
Definition: WrappedTargetException.idl:34
com::sun::star::beans::XPropertyContainer
makes it possible to add and remove properties to or from an object.
Definition: XPropertyContainer.idl:31
com::sun::star::document::XDocumentProperties
provides document-specific information such as the author, creation date, and user-defined fields.
Definition: XDocumentProperties.idl:44
com::sun::star::document::XDocumentProperties::Subject
string Subject
contains the subject of the document.
Definition: XDocumentProperties.idl:75
com::sun::star::document::XDocumentProperties::ModificationDate
com::sun::star::util::DateTime ModificationDate
contains the date and time of the last time the document was stored.
Definition: XDocumentProperties.idl:106
com::sun::star::document::XDocumentProperties::TemplateURL
string TemplateURL
contains the URL of the template from which the document was created.
Definition: XDocumentProperties.idl:137
com::sun::star::document::XDocumentProperties::getUserDefinedProperties
com::sun::star::beans::XPropertyContainer getUserDefinedProperties()
provides access to a container for user-defined properties.
com::sun::star::document::XDocumentProperties::Author
string Author
contains the initial author of the document.
Definition: XDocumentProperties.idl:48
com::sun::star::document::XDocumentProperties::Language
com::sun::star::lang::Locale Language
contains the default language of the document.
Definition: XDocumentProperties.idl:93
com::sun::star::document::XDocumentProperties::TemplateDate
com::sun::star::util::DateTime TemplateDate
contains the date and time of when the document was created or updated from the template.
Definition: XDocumentProperties.idl:143
com::sun::star::document::XDocumentProperties::storeToStorage
void storeToStorage([in] com::sun::star::embed::XStorage Storage, [in] sequence< com::sun::star::beans::PropertyValue > Medium)
stores document properties to an ODF package.
com::sun::star::document::XDocumentProperties::Generator
string Generator
identifies which application was used to create or last modify the document.
Definition: XDocumentProperties.idl:60
com::sun::star::document::XDocumentProperties::PrintedBy
string PrintedBy
contains the name of the person who most recently printed the document.
Definition: XDocumentProperties.idl:111
com::sun::star::document::XDocumentProperties::Description
string Description
contains a multi-line comment describing the document.
Definition: XDocumentProperties.idl:83
com::sun::star::document::XDocumentProperties::loadFromStorage
void loadFromStorage([in] com::sun::star::embed::XStorage Storage, [in] sequence< com::sun::star::beans::PropertyValue > Medium)
loads document properties from an ODF package.
com::sun::star::document::XDocumentProperties::resetUserData
void resetUserData([in] string Author)
resets all attributes that could identify the user.
com::sun::star::document::XDocumentProperties::loadFromMedium
void loadFromMedium([in] string URL, [in] sequence< com::sun::star::beans::PropertyValue > Medium)
loads document properties from an ODF package or an OLE container.
com::sun::star::document::XDocumentProperties::AutoloadURL
string AutoloadURL
contains the URL to load automatically at a specified time after the document is loaded into a deskto...
Definition: XDocumentProperties.idl:159
com::sun::star::document::XDocumentProperties::CreationDate
com::sun::star::util::DateTime CreationDate
contains the date and time when the document was created.
Definition: XDocumentProperties.idl:65
com::sun::star::document::XDocumentProperties::TemplateName
string TemplateName
contains the name of the template from which the document was created.
Definition: XDocumentProperties.idl:128
com::sun::star::document::XDocumentProperties::storeToMedium
void storeToMedium([in] string URL, [in] sequence< com::sun::star::beans::PropertyValue > Medium)
stores document properties to an ODF package or an OLE container.
com::sun::star::document::XDocumentProperties::ModifiedBy
string ModifiedBy
contains the name of the person who most recently stored the document.
Definition: XDocumentProperties.idl:98
com::sun::star::document::XDocumentProperties::Title
string Title
contains the title of the document.
Definition: XDocumentProperties.idl:70
com::sun::star::document::XDocumentProperties::PrintDate
com::sun::star::util::DateTime PrintDate
contains the date and time when the document was last printed.
Definition: XDocumentProperties.idl:119
com::sun::star::document::XDocumentProperties::Keywords
sequence< string > Keywords
contains a list of keywords for the document.
Definition: XDocumentProperties.idl:88
com::sun::star::document::XDocumentProperties::DocumentStatistics
sequence< com::sun::star::beans::NamedValue > DocumentStatistics
contains some statistics about the document.
Definition: XDocumentProperties.idl:197
com::sun::star::document::XDocumentProperties::DefaultTarget
string DefaultTarget
contains the name of the default frame into which links should be loaded if no target is specified.
Definition: XDocumentProperties.idl:188
com::sun::star::embed::XStorage
This interface represents main storage functionality.
Definition: XStorage.idl:27
com::sun::star::form::URL
@ URL
When the button is clicked, a URL set for the button is opened.
Definition: FormButtonType.idl:50
com
Definition: Ambiguous.idl:20
com::sun::star::lang::Locale
object represents a specific geographical, political, or cultural region.
Definition: Locale.idl:34
com::sun::star::util::DateTime
represents a combined date+time value.
Definition: DateTime.idl:27