LibreOffice
LibreOffice 6.2 SDK API Reference
Public Attributes | List of all members
MediaDescriptor Service Reference

describes properties of a document, regarding the relationship between the loaded document and the resource the document is loaded from / stored to. More...

import"MediaDescriptor.idl";

Public Attributes

boolean Aborted
 May be set by filters or detection services if user has chosen to abort loading/saving, e.g. More...
 
boolean AsTemplate
 document is a template More...
 
string Author
 the author of the document More...
 
string CharacterSet
 identifier of used character set More...
 
string Comment
 description of document More...
 
any ComponentData
 pack specific properties of caller More...
 
string DocumentBaseURL
 The base URL of the document to be used to resolve relative links. More...
 
string DocumentTitle
 document title More...
 
sequence< ::com::sun::star::beans::NamedValueEncryptionData
 encryption information for encryption/decryption of documents More...
 
string FileName
 same as MediaDescriptor::URL More...
 
string FilterName
 internal filter name More...
 
string FilterFlags
 same as MediaDescriptor::FilterOptions More...
 
string FilterOptions
 additional properties for filter More...
 
any FilterData
 additional properties for filter More...
 
boolean Hidden
 load document invisible More...
 
string HierarchicalDocumentName
 The hierarchical path to the embedded document from topmost container. More...
 
com::sun::star::io::XOutputStream OutputStream
 a stream to receive the document data. More...
 
com::sun::star::io::XInputStream InputStream
 content of document More...
 
com::sun::star::task::XInteractionHandler InteractionHandler
 handle exceptional situations More...
 
string JumpMark
 jump to a marked position after loading More...
 
string MediaType
 specify mime type of content More...
 
string OpenFlags
 please use the corresponding parameters of this descriptor instead More...
 
boolean OpenNewView
 opens a new view for an already loaded document More...
 
boolean Overwrite
 overwrite any existing file More...
 
string Password
 password for loading storing documents More...
 
sequence< byte > PostData
 contains the data for HTTP post method as a sequence of bytes. More...
 
string PostString
 use MediaDescriptor::PostData instead of this More...
 
boolean Preview
 show preview More...
 
boolean ReadOnly
 open document readonly More...
 
boolean StartPresentation
 start presentation from a document More...
 
string Referer
 name of document referrer More...
 
boolean RepairPackage
 let the document be opened in repair mode More...
 
com::sun::star::task::XStatusIndicator StatusIndicator
 can be used for status information More...
 
string SuggestedSaveAsDir
 allows to specify the URL that is used next time SaveAs dialog is opened More...
 
string SuggestedSaveAsName
 allows to specify the suggested file name that is used next time SaveAs dialog is opened More...
 
string TemplateName
 name of the template instead of the URL More...
 
string TemplateRegionName
 name of the template instead of the URL More...
 
boolean Unpacked
 regulate using of compressing More...
 
string URL
 URL of the document. More...
 
short Version
 storage version More...
 
any ViewData
 set special view state More...
 
short ViewId
 id of the initial view More...
 
short MacroExecutionMode
 should the macro be executed. More...
 
short UpdateDocMode
 can the document be updated depending from links. More...
 
string ViewControllerName
 specifies the name of the view controller to create when loading a document More...
 
com::sun::star::frame::XFrame Frame
 specifies the frame containing the document. More...
 

Detailed Description

describes properties of a document, regarding the relationship between the loaded document and the resource the document is loaded from / stored to.

This service may be represented by a com::sun::star::beans::PropertyValue[]. Such descriptors will be passed to different functions, included into possible load/save processes. Every member of such process can use this descriptor and may change it if to actualize the information about the document. So this descriptor should be used as an in/out parameter.

Note:
It's not allowed to hold member of this descriptor by references longer than they will be used (especially a possible stream). It's allowed to use it directly or by copying it only.

See also
com::sun::star::beans::PropertyValue
Developers Guide
OfficeDev - Handling Documents - Loading Documents - MediaDescriptor

Member Data Documentation

boolean Aborted
optionalproperty

May be set by filters or detection services if user has chosen to abort loading/saving, e.g.

while entering a password.

boolean AsTemplate
optionalproperty

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.

string Author
optionalproperty

the author of the document

Only for storing versions in components supporting versioning: author of version.

string CharacterSet
optionalproperty

identifier of used character set

Defines the character set for document formats that contain single byte characters (if necessary).

string Comment
optionalproperty

description of document

Only for storing versions in components supporting versioning: comment (description) for stored version.

any ComponentData
optionalproperty

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 addressed component.

For extensibility, it is recommended to use values of type sequence<com.sun.star.beans.NamedValue> with this property.

string DocumentBaseURL
optionalproperty

The base URL of the document to be used to resolve relative links.

string DocumentTitle
optionalproperty

document title

This parameter can be used to specify a title for a document.

sequence< ::com::sun::star::beans::NamedValue > EncryptionData
optionalproperty

encryption information for encryption/decryption of documents

It contains the necessary information for encryption/decryption of a component (if necessary). If neither password nor encryption data is specified, loading of a password protected document will fail, storing will be done without encryption. If both are provided, the encryption data is used ( if the filter supports it ).

The encryption data is generated based on the password.

string FileName
optionalproperty

same as MediaDescriptor::URL

It will be supported for compatibility reasons only.

Deprecated:
any FilterData
optionalproperty

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 MediaDescriptor::FilterOptions isn't enough.

string FilterFlags
optionalproperty

same as MediaDescriptor::FilterOptions

It will be supported for compatibility reasons only.

Deprecated:
string FilterName
optionalproperty

internal filter name

Name of a filter that should be used for loading or storing the component. Names must match the names of the 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.

string FilterOptions
optionalproperty

additional properties for filter

Some filters need additional parameters; use only together with property 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 MediaDescriptor::FilterData.

com::sun::star::frame::XFrame Frame
optionalproperty

specifies the frame containing the document.

May be empty.

boolean Hidden
optionalproperty

load document invisible

Defines if the loaded component is made visible. If this property is not specified, the component is made visible by default.

string HierarchicalDocumentName
optionalproperty

The hierarchical path to the embedded document from topmost container.

com::sun::star::io::XInputStream InputStream
optionalproperty

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 reading only once, except when it also implements the com::sun::star::io::XSeekable interface.

com::sun::star::task::XInteractionHandler InteractionHandler
optionalproperty

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 component's copy of the MediaDescriptor provided by its arguments attribute.

string JumpMark
optionalproperty

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.

short MacroExecutionMode
optionalproperty

should the macro be executed.

the value should be one from com::sun::star::document::MacroExecMode constant list.

Since
OOo 1.1.2
string MediaType
optionalproperty

specify mime type of content

Type of the medium to load, that must match to one of the types defined in the 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.

string OpenFlags
optionalproperty

please use the corresponding parameters of this descriptor instead

String that summarizes some flags for loading. The string contains capital letters for the flags:

flag value replacement
ReadOnly R MediaDescriptor::ReadOnly
Preview B MediaDescriptor::Preview
AsTemplate T MediaDescriptor::AsTemplate
Hidden H MediaDescriptor::Hidden
Deprecated:
boolean OpenNewView
optionalproperty

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.

com::sun::star::io::XOutputStream OutputStream
optionalproperty

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.

boolean Overwrite
optionalproperty

overwrite any existing file

For storing only: overwrite any existing file, default is FALSE, so an error occurs if the target file already exists.

string Password
optionalproperty

password for loading storing documents

It contains a password for loading or storing a component (if necessary). If neither password nor encryption data is specified, loading of a password protected document will fail, storing will be done without encryption. If both are provided, the encryption data is used ( if the filter supports it ).

sequence< byte > PostData
optionalproperty

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.

string PostString
optionalproperty

use MediaDescriptor::PostData instead of this

Same as PostData, but the data is transferred as a string (just for compatibility).

Deprecated:
boolean Preview
optionalproperty

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.

boolean ReadOnly
optionalproperty

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.

string Referer
optionalproperty

name of document referrer

A URL describing the environment of the request; e.g. 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, e.g. "macro:" URLs.
Don't be confused about the wrong spelling; it is kept for compatibility reasons.

boolean RepairPackage
optionalproperty

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
OOo 1.1.2
boolean StartPresentation
optionalproperty

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.

com::sun::star::task::XStatusIndicator StatusIndicator
optionalproperty

can be used for status information

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 component's copy of the MediaDescriptor provided by its arguments attribute.

string SuggestedSaveAsDir
optionalproperty

allows to specify the URL that is used next time SaveAs dialog is opened

If the parameter is specified, the URL will be used by SaveAs dialog next time as target folder.

string SuggestedSaveAsName
optionalproperty

allows to specify the suggested file name that is used next time SaveAs dialog is opened

If the parameter is specified, the file name will be suggested by SaveAs dialog next time.

string TemplateName
optionalproperty

name of the template instead of the URL

The logical name of a template to load. Together with the MediaDescriptor::TemplateRegion property it can be used instead of the URL of the template. Use always in conjunction with MediaDescriptor::TemplateRegionName.

string TemplateRegionName
optionalproperty

name of the template instead of the URL

See MediaDescriptor::TemplateName. The template region names are the folder names you see in the templates dialog.

boolean Unpacked
optionalproperty

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.

short UpdateDocMode
optionalproperty

can the document be updated depending from links.

the value should be one from com::sun::star::document::UpdateDocMode constant list.

Since
OOo 1.1.2
string URL
optionalproperty

URL of the document.

The location of the component in URL syntax. It must be the full qualified URL and

short Version
optionalproperty

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.

string ViewControllerName
optionalproperty

specifies the name of the view controller to create when loading a document

If this property is used when loading a document into a frame, then it specifies the name of the view controller to create. That is, the property is passed to the document's com::sun::star::frame::XModel2::createViewController() method.
If the loaded document does not support the XModel2 interface, the property is ignored.

See also
com::sun::star::frame::XModel2::createViewController
com::sun::star::frame::XController2::ViewControllerName
Since
OOo 3.0
any ViewData
optionalproperty

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.

short ViewId
optionalproperty

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.


The documentation for this service was generated from the following file: