Properties' Details |
AsTemplate
boolean AsTemplate;
- Usage Restrictions
- optional
- Description
- document is a template
Loading a component of type "template" creates a new untitled document
by default, but setting the "AsTemplate" property to false loads the
template document for editing. Setting "AsTemplate" to true creates a
new untitled document out of the loaded document, even if it has not
a "template" type.
|
|
Author
string Author;
- Usage Restrictions
- optional
- Description
- the author of the document
Only for storing versions in components supporting versioning:
author of version.
|
|
CharacterSet
string CharacterSet;
- Usage Restrictions
- optional
- Description
- identifier of used character set
Defines the character set for document formats that contain single
byte characters (if necessary).
|
|
Comment
string Comment;
- Usage Restrictions
- optional
- Description
- description of document
Only for storing versions in components supporting versioning:
comment (description) for stored version.
|
|
ComponentData
any ComponentData;
- Usage Restrictions
- optional
- Description
- pack specific properties of caller
This is a parameter that can be used for any properties specific
for a special component type. Format of that depends from real
type of adressed component.
|
|
DocumentBaseURL
string DocumentBaseURL;
- Usage Restrictions
- optional
- Description
- The base URL of the document to be used to resolve relative links.
|
|
DocumentTitle
string DocumentTitle;
- Usage Restrictions
- optional
- Description
- document title
This parameter can be used to specify a title for a document.
|
|
FileName
string FileName;
- Usage Restrictions
- deprecated
- optional
- Description
- same as ::com::sun::star::document::MediaDescriptor::URL
It will be supported for compatibility reasons only.
|
|
FilterName
string FilterName;
- Usage Restrictions
- optional
- Description
- internal filter name
Name of a filter that should be used for loading or storing the component.
Names must match the names of the ::com::sun::star::document::TypeDetection configuration,
invalid names are ignored. If a name is specified on loading,
it still will be verified by a filter detection, but in case of doubt
it will be preferred.
|
|
FilterFlags
string FilterFlags;
- Usage Restrictions
- deprecated
- optional
- Description
- same as ::com::sun::star::document::MediaDescriptor::FilterOptions
It will be supported for compatibility reasons only.
|
|
FilterOptions
string FilterOptions;
- Usage Restrictions
- optional
- Description
- additional properties for filter
Some filters need additional parameters; use only together with property
::com::sun::star::document::MediaDescriptor::FilterName . Details must be documented
by the filter. This is an old format for some filters. If a string is not
enough, filters can use the property ::com::sun::star::document::MediaDescriptor::FilterData .
|
|
FilterData
any FilterData;
- Usage Restrictions
- optional
- Description
- additional properties for filter
This is a parameter that can be used for any properties specific
for a special filter type. It should be used if
::com::sun::star::document::MediaDescriptor::FilterOptions isn't enough.
|
|
Hidden
boolean Hidden;
- Usage Restrictions
- optional
- Description
- load document invisible
Defines if the loaded component is made visible. If this property is not
specified, the component is made visible by default.
|
|
HierarchicalDocumentName
string HierarchicalDocumentName;
- Usage Restrictions
- optional
- Description
- The hierarchical path to the embedded document from topmost container.
|
|
OutputStream
::com::sun::star::io::XOutputStream OutputStream;
- Usage Restrictions
- optional
- Description
- a stream to receive the document data.
If used when storing a document: writing must be done using this stream.
If no stream is provided, the loader will create a stream by itself using
the other properties. It is not allowed to keep a reference to this
OutputStream after storing the component.
|
|
InputStream
::com::sun::star::io::XInputStream InputStream;
- Usage Restrictions
- optional
- Description
- content of document
If used when loading a document: reading must be done using this stream.
If no stream is provided, the loader will create a stream by itself using
the other properties. It is not allowed to keep a reference to this
InputStream after loading the component, and it would be useless, because
in general an InputStream is usable for readong only once, except when it
also implements the ::com::sun::star::io::XSeekable interface.
|
|
InteractionHandler
::com::sun::star::task::XInteractionHandler InteractionHandler;
- Usage Restrictions
- optional
- Description
- handle exceptional situations
Object implementing the ::com::sun::star::task::InteractionHandler
service that is used to handle exceptional situations where proceeding with the task
is impossible without additional information or impossible at all.
The implemented api provides a default implementation for it that can handle many situations.
If no InteractionHandler is set, a suitable exception is thrown.
It is not allowed to keep a reference to this object, even not in the loaded
or stored components' copy of the MediaDescriptor provided by its arguments attribute.
|
|
JumpMark
string JumpMark;
- Usage Restrictions
- optional
- Description
- jump to a marked position after loading
This is the same as the text behind a '#' in a http URL. But
this syntax with a '#' is not specified in most URL schemas.
|
|
MediaType
string MediaType;
- Usage Restrictions
- optional
- Description
- specify mime type of content
Type of the medium to load, that must match to one of the types defined
in the ::com::sun::star::document::TypeDetection configuration (otherwise it's ignored).
This bypasses the type detection of the ::com::sun::star::frame::Desktop environment,
so passing a wrong MediaType will cause failure of loading.
|
|
OpenFlags
string OpenFlags;
- Usage Restrictions
- deprecated
- optional
- Description
- please use the corresponding parameters of this descriptor instead
String that summarizes some flags for loading. The string contains capital
letters for the flags:
|
|
OpenNewView
boolean OpenNewView;
- Usage Restrictions
- optional
- Description
- opens a new view for an already loaded document
Setting this to true forces the component to create a new window on loading
in any case. If the component supports multiple views, a second view is
opened, if not, the component is loaded one more time. Otherwise the behavior
depends on the default window handling of the ::com::sun::star::frame::Desktop environment.
|
|
Overwrite
boolean Overwrite;
- Usage Restrictions
- optional
- Description
- overwrite any existing file
For storing only: overwrite any existing file, default is false ,
so an error occurs if the target file already exists.
|
|
Password
string Password;
- Usage Restrictions
- optional
- Description
- pasword for loading storing documents
It caontains a password for loading or storing a component (if necessary).
If no password is specified, loading of a password protected document
will fail, storing will be done without encryption.
|
|
PostData
sequence< byte > PostData;
- Usage Restrictions
- optional
- Description
- contains the data for HTTP post method as a sequence of bytes.
Data to send to a location described by the media descriptor to get
a result in return that will be loaded as a component
(usually in webforms). Default is: no PostData.
|
|
PostString
string PostString;
- Usage Restrictions
- deprecated
- optional
- Description
- use ::com::sun::star::document::MediaDescriptor::PostData instead of this
Same as PostData, but the data is transferred as a string
(just for compatibility).
|
|
Preview
boolean Preview;
- Usage Restrictions
- optional
- Description
- show preview
Setting this to true tells the a loaded component that it is loaded as
a preview, so it can optimize loading and viewing for this special purpose.
Default is false .
|
|
ReadOnly
boolean ReadOnly;
- Usage Restrictions
- optional
- Description
- open document readonly
Tells whether a document should be loaded in a (logical) readonly or in
read/write mode. If opening in the desired mode is impossible, an error occurs.
By default the loaded content decides what to do: if its UCB content supports
a "readonly" property, the logical open mode depends on that, otherwise
it will be read/write. This is only a UI related property, opening a
document in read only mode will not prevent the component from being
modified by API calls, but all modifying functionality in the UI will
be disabled or removed.
|
|
StartPresentation
boolean StartPresentation;
- Usage Restrictions
- optional
- Description
- start presentation from a document
Tells the component loading the document that a presentation that is in the
document is to be started right away.
|
|
Referer
string Referer;
- Usage Restrictions
- optional
- Description
- name of document referrer
A URL describing the environment of the request; f.e. a referrer may be a
URL of a document, if a hyperlink inside this document is clicked to load
another document. The referrer may be evaluated by the addressed UCB content
or the loaded document. Without a referrer the processing of URLs that
needs security checks will be denied, f.e. "macro:" URLs.
Don't be confused about the wrong spelling; is kept for compatibility reasons.
|
|
RepairPackage
boolean RepairPackage;
- Usage Restrictions
- optional
- Description
- let the document be opened in repair mode
For loading of corrupted zip packages: Setting this to true let the document
be opened in repair mode, so as much as possible information will be retrieved.
- Since
- OpenOffice 1.1.2
|
|
StatusIndicator
::com::sun::star::task::XStatusIndicator StatusIndicator;
- Usage Restrictions
- optional
- Description
- can be used for status informations
Object implementing the ::com::sun::star::task::XStatusIndicator
interface that can be used to give status information (text or progress) for the task.
The office provides a default implementation for it. It is not allowed to keep
a reference to this object, even not in the loaded or stored components'
copy of the MediaDescriptor provided by its arguments attribute.
|
|
TemplateName
|
TemplateRegionName
|
Unpacked
boolean Unpacked;
- Usage Restrictions
- optional
- Description
- regulate using of compressing
For storing: Setting this to true means, don't use a zip file to save
the document, use a folder instead (only usable for UCB contents, that
support folders). Default is false .
|
|
URL
string URL;
- Usage Restrictions
- optional
- Description
- URL of the document
The location of the component in URL syntax. It must be the full qualified URL and
must include f.e. an optional ::com::sun::star::document::MediaDescriptor::JumpMark too.
|
|
Version
short Version;
- Usage Restrictions
- optional
- Description
- storage version
For components supporting versioning: the number of the version to be
loaded or saved. Default is zero and means: no version is created or
loaded, the "main" document is processed.
|
|
ViewData
any ViewData;
- Usage Restrictions
- optional
- Description
- set special view state
Data to set a special view state after loading. The type depends on
the component and is usually retrieved from a ::com::sun::star::frame::Controller
object by its ::com::sun::star::frame::XController
interface. Default is: no view data.
|
|
ViewId
short ViewId;
- Usage Restrictions
- optional
- Description
- id of the initial view
For components supporting different views: a number to define the view
that should be constructed after loading. Default is: zero, and this
should be treated by the component as the default view.
|
|
MacroExecutionMode
short MacroExecutionMode;
- Usage Restrictions
- optional
- Description
- should the macro be executed.
the value should be one from ::com::sun::star::document::MacroExecMode
constant list.
- Since
- OpenOffice 1.1.2
|
|
UpdateDocMode
short UpdateDocMode;
- Usage Restrictions
- optional
- Description
- can the document be updated depending from links.
the value should be one from ::com::sun::star::document::UpdateDocMode
constant list.
- Since
- OpenOffice 1.1.2
|
|
Copyright © 2003 Sun Microsystems, Inc.