LibreOffice
LibreOffice 24.8 SDK API Reference
 
Loading...
Searching...
No Matches
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{
47
48 [attribute] string Author;
49
59
60 [attribute] string Generator;
61
64
66
69
70 [attribute] string Title;
71
74
75 [attribute] string Subject;
76
82
83 [attribute] string Description;
84
87
88 [attribute] sequence< string > Keywords;
89
92
94
97
98 [attribute] string ModifiedBy;
99
105
107
110
111 [attribute] string PrintedBy;
112
118
120
127
128 [attribute] string TemplateName;
129
136
137 [attribute] string TemplateURL;
138
142
144
158
159 [attribute] string AutoloadURL;
160
176
177 [attribute] long AutoloadSecs {
179 };
180
187
188 [attribute] string DefaultTarget;
189
195
196 [attribute]
197 sequence< com::sun::star::beans::NamedValue > DocumentStatistics;
198
206
207 [attribute] short EditingCycles {
209 };
210
218
219 [attribute] long EditingDuration {
221 };
222
245 void resetUserData( [in] string Author );
246
254
256
284
286 [in] sequence < com::sun::star::beans::PropertyValue > Medium )
291
313
314 void loadFromMedium( [in] string URL,
315 [in] sequence < com::sun::star::beans::PropertyValue > Medium )
319
348
350 [in] sequence < com::sun::star::beans::PropertyValue > Medium )
354
374
375 void storeToMedium( [in] string URL,
376 [in] sequence < com::sun::star::beans::PropertyValue > Medium )
379};
380
381
382}; }; }; };
383
384/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
is thrown when an input or output error has occurred.
Definition IOException.idl:27
is thrown when inconsistent data comes up while reading a complex data type (string or object).
Definition WrongFormatException.idl:28
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition IllegalArgumentException.idl:27
This is a checked exception that wraps an exception thrown by the original target.
Definition WrappedTargetException.idl:34
makes it possible to add and remove properties to or from an object.
Definition generated_idl_chapter_refs.idl:833
provides document-specific information such as the author, creation date, and user-defined fields.
Definition XDocumentProperties.idl:44
string Subject
contains the subject of the document.
Definition XDocumentProperties.idl:75
com::sun::star::util::DateTime ModificationDate
contains the date and time of the last time the document was stored.
Definition XDocumentProperties.idl:106
string TemplateURL
contains the URL of the template from which the document was created.
Definition XDocumentProperties.idl:137
long AutoloadSecs
contains the number of seconds after which a specified URL is to be loaded after the document is load...
Definition XDocumentProperties.idl:179
com::sun::star::beans::XPropertyContainer getUserDefinedProperties()
provides access to a container for user-defined properties.
short EditingCycles
describes how often the document was edited and saved.
Definition XDocumentProperties.idl:209
string Author
contains the initial author of the document.
Definition XDocumentProperties.idl:48
com::sun::star::lang::Locale Language
contains the default language of the document.
Definition XDocumentProperties.idl:93
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
void storeToStorage([in] com::sun::star::embed::XStorage Storage, [in] sequence< com::sun::star::beans::PropertyValue > Medium)
stores document properties to an ODF package.
string Generator
identifies which application was used to create or last modify the document.
Definition XDocumentProperties.idl:60
string PrintedBy
contains the name of the person who most recently printed the document.
Definition XDocumentProperties.idl:111
string Description
contains a multi-line comment describing the document.
Definition XDocumentProperties.idl:83
void loadFromStorage([in] com::sun::star::embed::XStorage Storage, [in] sequence< com::sun::star::beans::PropertyValue > Medium)
loads document properties from an ODF package.
void resetUserData([in] string Author)
resets all attributes that could identify the user.
void loadFromMedium([in] string URL, [in] sequence< com::sun::star::beans::PropertyValue > Medium)
loads document properties from an ODF package or an OLE container.
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::util::DateTime CreationDate
contains the date and time when the document was created.
Definition XDocumentProperties.idl:65
string TemplateName
contains the name of the template from which the document was created.
Definition XDocumentProperties.idl:128
void storeToMedium([in] string URL, [in] sequence< com::sun::star::beans::PropertyValue > Medium)
stores document properties to an ODF package or an OLE container.
string ModifiedBy
contains the name of the person who most recently stored the document.
Definition XDocumentProperties.idl:98
string Title
contains the title of the document.
Definition XDocumentProperties.idl:70
com::sun::star::util::DateTime PrintDate
contains the date and time when the document was last printed.
Definition XDocumentProperties.idl:119
sequence< string > Keywords
contains a list of keywords for the document.
Definition XDocumentProperties.idl:88
sequence< com::sun::star::beans::NamedValue > DocumentStatistics
contains some statistics about the document.
Definition XDocumentProperties.idl:197
long EditingDuration
contains the net time of editing the document (in seconds).
Definition XDocumentProperties.idl:221
string DefaultTarget
contains the name of the default frame into which links should be loaded if no target is specified.
Definition XDocumentProperties.idl:188
This interface represents main storage functionality.
Definition XStorage.idl:27
Definition Ambiguous.idl:20
object represents a specific geographical, political, or cultural region.
Definition Locale.idl:34
represents a combined date+time value.
Definition DateTime.idl:27