Top   Module   Use   Manual   Index 
 INCLUDED SERVICES | EXPORTED INTERFACES | PROPERTIES' SUMMARY | PROPERTIES' DETAILS 

com :: sun :: star :: document ::

service MediaDescriptor

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 PropertyValue [] .

See also
com::sun::star::beans::PropertyValue


Properties' Summary

AsTemplate document is a template.
CharacterSet identifier of used character set.
FilterName internal filter name.
FrameName name of target frame.
Hidden load document, invisible.
InputStream content of document.
JumpMark specifies the name of a mark within the document where the first view is to position itself.
MediaType mime type.
OpenNewView opens a new view for an already loaded document.
PosSize position and size of document window.
PostData contains the data for HTTP post method as a sequence of bytes.
PostString contains the data for HTTP post method as a sequence of bytes.
Preview show preview.
ReadOnly open document readonly.
Referer name of document referrer.
Silent prevents dialogs to query for more information.
TemplateName [ DEPRECATED ]
name of the template instead of the URL.
TemplateRegionName [ DEPRECATED ]
name of the region of the template.
URL URL of the document.
Version storage version.
ViewId id of the initial view.

Properties' Details

AsTemplate
 
boolean AsTemplate;
Description
document is a template.
CharacterSet
 
string CharacterSet;
Description
identifier of used character set.
FilterName
 
string FilterName;
Description
internal filter name.
FrameName
 
string FrameName;
Description
name of target frame.
Hidden
 
boolean Hidden;
Description
load document, invisible.
InputStream
 
com::sun::star::io::XInputStream InputStream;
Description
content of document.
JumpMark
 
string JumpMark;
Description
specifies the name of a mark within the document where the first view is to position itself.

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;
Description
mime type.
OpenNewView
 
boolean OpenNewView;
Description
opens a new view for an already loaded document.
PosSize
 
com::sun::star::awt::Rectangle PosSize;
Description
position and size of document window.
PostData
 
sequence< byte > PostData;
Description
contains the data for HTTP post method as a sequence of bytes.

An example would be the data from a web form. This property is actually handled, not MediaDescriptor::PostString , which is for convienience.

PostString
 
string PostString;
Description
contains the data for HTTP post method as a sequence of bytes.

For example, this is the data from a web form. This property is actually only for convienience and the data will interally processed as MediaDescriptor::PostData .

Preview
 
boolean Preview;
Description
show preview.
ReadOnly
 
boolean ReadOnly;
Description
open document readonly.
Referer
 
string Referer;
Description
name of document referrer.
Silent
 
boolean Silent;
Description
prevents dialogs to query for more information.
TemplateName
 
string TemplateName;
[ DEPRECATED ]
Description
name of the template instead of the URL.

Use always in conjunction with MediaDescriptor::TemplateRegionName .

TemplateRegionName
 
string TemplateRegionName;
[ DEPRECATED ]
Description
name of the region of the template.

Use always in conjunction with MediaDescriptor::TemplateName .

URL
 
com::sun::star::util::URL URL;
Description
URL of the document.
Version
 
short Version;
Description
storage version.
ViewId
 
short ViewId;
Description
id of the initial view.

Top of Page