<html> <head> <title>Service MediaDescriptor</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="MediaDescriptor-xref.html" class="navimain">Use</a></td> <td class="navimain"><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Handling_Documents#MediaDescriptor" class="navimain">Devguide</a></td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub">Included Services</td> <td class="navisub">Exported Interfaces</td> <td class="navisub"><a href="#PropertiesSummary" class="navisub">Properties' Summary</a></td> <td class="navisub"><a href="#PropertiesDetails" class="navisub">Properties' Details</a></td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">document</a> :: </p> </td> </tr> <tr> <td class="title">service MediaDescriptor</td> </tr> <tr> <td><dl> <dt><b>Description</b></dt> <dd>describes properties of a document, regarding the relationship between the loaded document and the resource the document is loaded from / stored to. </dd> <dd><p> This service may be represented by a ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a>[]. Such descriptors will be passed to different functions, included into possible load/save proccesses. Every member of such process can use this descriptor and may change it if to actualize the informations about the document. So this descriptor should be used as an in/out parameter. </p> <p> Note:<br> It's not allowed to hold member of this descriptor by references longer the they will be used (especialy a possible stream). It's allowed to use it directly or by copying it only. </p> </dd> <dt><b>See also</b></dt> <dd>::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/PropertyValue.html">PropertyValue</a></dd> </dl> <a name="devmanual"> </a><dl> <dt><b>Developers Guide</b></dt> <dd><a href="http://wiki.services.openoffice.org/wiki/Documentation/DevGuide/OfficeDev/Handling_Documents#MediaDescriptor">OfficeDev - Handling Documents - Loading Documents - MediaDescriptor</a></dd> </dl> </td> </tr> </table> <hr> <a name="PropertiesSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Properties' Summary</td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#AsTemplate">AsTemplate</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>document is a template </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Author">Author</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>the author of the document </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#CharacterSet">CharacterSet</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>identifier of used character set </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Comment">Comment</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>description of document </td> </tr> <tr> <td class="imsum_left">any<br> <a href="#ComponentData">ComponentData</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>pack specific properties of caller </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#DocumentBaseURL">DocumentBaseURL</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>The base URL of the document to be used to resolve relative links. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#DocumentTitle">DocumentTitle</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>document title </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#FileName">FileName</a></td> <td class="imsum_right"><b>[ DEPRECATED ]<br> </b><b>[ OPTIONAL ]<br> </b>same as <a href="MediaDescriptor.html">MediaDescriptor</a>::<a href="MediaDescriptor.html#URL">URL</a> </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#FilterName">FilterName</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>internal filter name </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#FilterFlags">FilterFlags</a></td> <td class="imsum_right"><b>[ DEPRECATED ]<br> </b><b>[ OPTIONAL ]<br> </b>same as <a href="MediaDescriptor.html">MediaDescriptor</a>::<a href="MediaDescriptor.html#FilterOptions">FilterOptions</a> </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#FilterOptions">FilterOptions</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>additional properties for filter </td> </tr> <tr> <td class="imsum_left">any<br> <a href="#FilterData">FilterData</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>additional properties for filter </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Hidden">Hidden</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>load document invisible </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#HierarchicalDocumentName">HierarchicalDocumentName</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>The hierarchical path to the embedded document from topmost container. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XOutputStream.html">XOutputStream</a><br> <a href="#OutputStream">OutputStream</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>a stream to receive the document data. </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a><br> <a href="#InputStream">InputStream</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>content of document </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XInteractionHandler.html">XInteractionHandler</a><br> <a href="#InteractionHandler">InteractionHandler</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>handle exceptional situations </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#JumpMark">JumpMark</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>jump to a marked position after loading </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#MediaType">MediaType</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>specify mime type of content </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#OpenFlags">OpenFlags</a></td> <td class="imsum_right"><b>[ DEPRECATED ]<br> </b><b>[ OPTIONAL ]<br> </b>please use the corresponding parameters of this descriptor instead </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#OpenNewView">OpenNewView</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>opens a new view for an already loaded document </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Overwrite">Overwrite</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>overwrite any existing file </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Password">Password</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>pasword for loading storing documents </td> </tr> <tr> <td class="imsum_left">sequence< byte ><br> <a href="#PostData">PostData</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>contains the data for HTTP post method as a sequence of bytes. </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#PostString">PostString</a></td> <td class="imsum_right"><b>[ DEPRECATED ]<br> </b><b>[ OPTIONAL ]<br> </b>use <a href="MediaDescriptor.html">MediaDescriptor</a>::<a href="MediaDescriptor.html#PostData">PostData</a> instead of this </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Preview">Preview</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>show preview </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#ReadOnly">ReadOnly</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>open document readonly </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#StartPresentation">StartPresentation</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>start presentation from a document </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#Referer">Referer</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>name of document referrer </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#RepairPackage">RepairPackage</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>let the document be opened in repair mode </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XStatusIndicator.html">XStatusIndicator</a><br> <a href="#StatusIndicator">StatusIndicator</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>can be used for status informations </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#TemplateName">TemplateName</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>name of the template instead of the URL </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#TemplateRegionName">TemplateRegionName</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>name of the template instead of the URL </td> </tr> <tr> <td class="imsum_left">boolean<br> <a href="#Unpacked">Unpacked</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>regulate using of compressing </td> </tr> <tr> <td class="imsum_left">string<br> <a href="#URL">URL</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>URL of the document </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#Version">Version</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>storage version </td> </tr> <tr> <td class="imsum_left">any<br> <a href="#ViewData">ViewData</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>set special view state </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#ViewId">ViewId</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>id of the initial view </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#MacroExecutionMode">MacroExecutionMode</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>should the macro be executed. the value should be one from <a href="MacroExecMode.html">MacroExecMode</a> constant list. </td> </tr> <tr> <td class="imsum_left">short<br> <a href="#UpdateDocMode">UpdateDocMode</a></td> <td class="imsum_right"><b>[ OPTIONAL ]<br> </b>can the document be updated depending from links. the value should be one from <a href="UpdateDocMode.html">UpdateDocMode</a> constant list. </td> </tr> </table> <a name="PropertiesDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Properties' Details</td> </tr> <tr> <td class="imdetail"><a name="AsTemplate" class="membertitle">AsTemplate</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>AsTemplate</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>document is a template </dd> <dd><p> Loading a component of type "template" creates a new untitled document by default, but setting the "AsTemplate" property to <b>false</b> loads the template document for editing. Setting "AsTemplate" to <b>true</b> creates a new untitled document out of the loaded document, even if it has not a "template" type. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Author" class="membertitle">Author</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Author</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>the author of the document </dd> <dd><p> Only for storing versions in components supporting versioning: author of version. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="CharacterSet" class="membertitle">CharacterSet</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>CharacterSet</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>identifier of used character set </dd> <dd><p> Defines the character set for document formats that contain single byte characters (if necessary). </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Comment" class="membertitle">Comment</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Comment</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>description of document </dd> <dd><p> Only for storing versions in components supporting versioning: comment (description) for stored version. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ComponentData" class="membertitle">ComponentData</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>any <b>ComponentData</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>pack specific properties of caller </dd> <dd><p> 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. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DocumentBaseURL" class="membertitle">DocumentBaseURL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>DocumentBaseURL</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>The base URL of the document to be used to resolve relative links. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="DocumentTitle" class="membertitle">DocumentTitle</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>DocumentTitle</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>document title </dd> <dd><p> This parameter can be used to specify a title for a document. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FileName" class="membertitle">FileName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>FileName</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>deprecated</i></dd> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>same as <a href="MediaDescriptor.html">MediaDescriptor</a>::<a href="MediaDescriptor.html#URL">URL</a> </dd> <dd><p> It will be supported for compatibility reasons only. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FilterName" class="membertitle">FilterName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>FilterName</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>internal filter name </dd> <dd><p> Name of a filter that should be used for loading or storing the component. Names must match the names of the <a href="TypeDetection.html">TypeDetection</a> 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. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FilterFlags" class="membertitle">FilterFlags</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>FilterFlags</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>deprecated</i></dd> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>same as <a href="MediaDescriptor.html">MediaDescriptor</a>::<a href="MediaDescriptor.html#FilterOptions">FilterOptions</a> </dd> <dd><p> It will be supported for compatibility reasons only. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FilterOptions" class="membertitle">FilterOptions</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>FilterOptions</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>additional properties for filter </dd> <dd><p> Some filters need additional parameters; use only together with property <a href="MediaDescriptor.html">MediaDescriptor</a>::<a href="MediaDescriptor.html#FilterName">FilterName</a>. 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 <a href="MediaDescriptor.html">MediaDescriptor</a>::<a href="MediaDescriptor.html#FilterData">FilterData</a>. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="FilterData" class="membertitle">FilterData</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>any <b>FilterData</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>additional properties for filter </dd> <dd><p> This is a parameter that can be used for any properties specific for a special filter type. It should be used if <a href="MediaDescriptor.html">MediaDescriptor</a>::<a href="MediaDescriptor.html#FilterOptions">FilterOptions</a> isn't enough. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Hidden" class="membertitle">Hidden</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Hidden</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>load document invisible </dd> <dd><p> Defines if the loaded component is made visible. If this property is not specified, the component is made visible by default. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="HierarchicalDocumentName" class="membertitle">HierarchicalDocumentName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>HierarchicalDocumentName</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>The hierarchical path to the embedded document from topmost container. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="OutputStream" class="membertitle">OutputStream</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XOutputStream.html">XOutputStream</a> <b>OutputStream</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>a stream to receive the document data. </dd> <dd><p> 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. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="InputStream" class="membertitle">InputStream</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../io/module-ix.html">io</a>::<a href="../io/XInputStream.html">XInputStream</a> <b>InputStream</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>content of document </dd> <dd><p> 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::<a href="../io/module-ix.html">io</a>::<a href="../io/XSeekable.html">XSeekable</a> interface. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="InteractionHandler" class="membertitle">InteractionHandler</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XInteractionHandler.html">XInteractionHandler</a> <b>InteractionHandler</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>handle exceptional situations </dd> <dd><p> Object implementing the ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/InteractionHandler.html">InteractionHandler</a> 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. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="JumpMark" class="membertitle">JumpMark</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>JumpMark</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>jump to a marked position after loading </dd> <dd><p> 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. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MediaType" class="membertitle">MediaType</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>MediaType</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>specify mime type of content </dd> <dd><p> Type of the medium to load, that must match to one of the types defined in the <a href="TypeDetection.html">TypeDetection</a> configuration (otherwise it's ignored). This bypasses the type detection of the ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/Desktop.html">Desktop</a> environment, so passing a wrong MediaType will cause failure of loading. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="OpenFlags" class="membertitle">OpenFlags</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>OpenFlags</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>deprecated</i></dd> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>please use the corresponding parameters of this descriptor instead </dd> <dd><p> String that summarizes some flags for loading. The string contains capital letters for the flags:<br> <table border=1> <tr> <td><strong>flag</strong></td> <td><strong>value</strong></td> <td><strong>replacement</strong></td> </tr> <tr> <td><em>ReadOnly</em></td> <td>R</td> <td><a href="MediaDescriptor.html">MediaDescriptor</a>::<a href="MediaDescriptor.html#ReadOnly">ReadOnly</a></td> </tr> <tr> <td><em>Preview</em></td> <td>B</td> <td><a href="MediaDescriptor.html">MediaDescriptor</a>::<a href="MediaDescriptor.html#Preview">Preview</a></td> </tr> <tr> <td><em>AsTemplate</em></td> <td>T</td> <td><a href="MediaDescriptor.html">MediaDescriptor</a>::<a href="MediaDescriptor.html#AsTemplate">AsTemplate</a></td> </tr> <tr> <td><em>Hidden</em></td> <td>H</td> <td><a href="MediaDescriptor.html">MediaDescriptor</a>::<a href="MediaDescriptor.html#Hidden">Hidden</a></td> </tr> </table> </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="OpenNewView" class="membertitle">OpenNewView</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>OpenNewView</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>opens a new view for an already loaded document </dd> <dd><p> Setting this to <b>true</b> 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::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/Desktop.html">Desktop</a> environment. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Overwrite" class="membertitle">Overwrite</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Overwrite</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>overwrite any existing file </dd> <dd><p> For storing only: overwrite any existing file, default is <b>false</b>, so an error occurs if the target file already exists. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Password" class="membertitle">Password</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Password</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>pasword for loading storing documents </dd> <dd><p> 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. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PostData" class="membertitle">PostData</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>sequence< byte > <b>PostData</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>contains the data for HTTP post method as a sequence of bytes. </dd> <dd><p> 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. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="PostString" class="membertitle">PostString</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>PostString</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>deprecated</i></dd> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>use <a href="MediaDescriptor.html">MediaDescriptor</a>::<a href="MediaDescriptor.html#PostData">PostData</a> instead of this </dd> <dd><p> Same as PostData, but the data is transferred as a string (just for compatibility). </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Preview" class="membertitle">Preview</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Preview</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>show preview </dd> <dd><p> Setting this to <b>true</b> 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 <b>false</b>. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ReadOnly" class="membertitle">ReadOnly</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>ReadOnly</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>open document readonly </dd> <dd><p> 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. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="StartPresentation" class="membertitle">StartPresentation</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>StartPresentation</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>start presentation from a document </dd> <dd><p> Tells the component loading the document that a presentation that is in the document is to be started right away. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Referer" class="membertitle">Referer</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>Referer</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>name of document referrer </dd> <dd><p> 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. <br> Don't be confused about the wrong spelling; is kept for compatibility reasons. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="RepairPackage" class="membertitle">RepairPackage</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>RepairPackage</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>let the document be opened in repair mode </dd> <dd><p> For loading of corrupted zip packages: Setting this to <b>true</b> let the document be opened in repair mode, so as much as possible information will be retrieved. </p> </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="StatusIndicator" class="membertitle">StatusIndicator</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XStatusIndicator.html">XStatusIndicator</a> <b>StatusIndicator</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>can be used for status informations </dd> <dd><p> Object implementing the ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XStatusIndicator.html">XStatusIndicator</a> 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. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TemplateName" class="membertitle">TemplateName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>TemplateName</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>name of the template instead of the URL </dd> <dd><p> The logical name of a template to load. Together with the <a href="MediaDescriptor.html">MediaDescriptor</a>::<a href="MediaDescriptor.html#TemplateRegion">TemplateRegion</a> property it can be used instead of the URL of the template. Use always in conjunction with <a href="MediaDescriptor.html">MediaDescriptor</a>::<a href="MediaDescriptor.html#TemplateRegionName">TemplateRegionName</a>. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="TemplateRegionName" class="membertitle">TemplateRegionName</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>TemplateRegionName</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>name of the template instead of the URL </dd> <dd><p> The logical name of a template to load. Together with the <a href="MediaDescriptor.html">MediaDescriptor</a>::<a href="MediaDescriptor.html#TemplateRegion">TemplateRegion</a> property it can be used instead of the URL of the template. Use always in conjunction with <a href="MediaDescriptor.html">MediaDescriptor</a>::<a href="MediaDescriptor.html#TemplateRegionName">TemplateRegionName</a>. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Unpacked" class="membertitle">Unpacked</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>boolean <b>Unpacked</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>regulate using of compressing </dd> <dd><p> For storing: Setting this to <b>true</b> 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 <b>false</b>. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="URL" class="membertitle">URL</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>string <b>URL</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>URL of the document </dd> <dd><p> The location of the component in URL syntax. It must be the full qualified URL and must include f.e. an optional <a href="MediaDescriptor.html">MediaDescriptor</a>::<a href="MediaDescriptor.html#JumpMark">JumpMark</a> too. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="Version" class="membertitle">Version</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>Version</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>storage version </dd> <dd><p> 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. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ViewData" class="membertitle">ViewData</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>any <b>ViewData</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>set special view state </dd> <dd><p> Data to set a special view state after loading. The type depends on the component and is usually retrieved from a ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/Controller.html">Controller</a> object by its ::com::sun::star::<a href="../frame/module-ix.html">frame</a>::<a href="../frame/XController.html">XController</a> interface. Default is: no view data. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="ViewId" class="membertitle">ViewId</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>ViewId</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>id of the initial view </dd> <dd><p> 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. </p> </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="MacroExecutionMode" class="membertitle">MacroExecutionMode</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>MacroExecutionMode</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>should the macro be executed. the value should be one from <a href="MacroExecMode.html">MacroExecMode</a> constant list. </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="UpdateDocMode" class="membertitle">UpdateDocMode</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-data" bgcolor="#ffffff" align="center"> <tr> <td>short <b>UpdateDocMode</b>;<hr> <dl> <dt><b>Usage Restrictions</b></dt> <dd><i>optional</i></dd> <dt><b>Description</b></dt> <dd>can the document be updated depending from links. the value should be one from <a href="UpdateDocMode.html">UpdateDocMode</a> constant list. </dd> <dt><b/></dt> <dd/></dl> </td> </tr> </table> </td> </tr> </table> <br> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2008 Sun Microsystems, Inc.</p> </div> <!-- id="adc-idlref" --> </body> </html>
distrib
>
Mandriva
>
2008.1
>
x86_64
>
media
>
main-testing
>
by-pkgid
>
2c50825dd66d0497b96a67f7fab2ee84
>
files
>
2378
