Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: view ::

interface XRenderable
Description
represents something that can be rendered.
Since
OOo 1.1.2

Methods' Summary
getRendererCount  
getRenderer  
render renders the object.  
Methods' Details
getRendererCount
long
getRendererCount( [in] any  aSelection,
[in] sequence< ::com::sun::star::beans::PropertyValue >  xOptions )
raises( ::com::sun::star::lang::IllegalArgumentException );

Returns
the count of renderers (based on paper count of a document, for example).

If a selection is given, the count has to be calculated based on this selection. The other methods of this interface will rely on this value if called.

If the selection contains a valid XModel interface, it is assumed that the whole document should be rendered. If the selection is empty, nothing should be rendered.

See also
RenderOptions
getRenderer
sequence< ::com::sun::star::beans::PropertyValue >
getRenderer( [in] long  nRenderer,
[in] any  aSelection,
[in] sequence< ::com::sun::star::beans::PropertyValue >  xOptions )
raises( ::com::sun::star::lang::IllegalArgumentException );

Returns
a descriptor of the specific renderer.

returns the specific renderer properties based on the given selection.

If the selection contains a valid XModel interface, it is assumed that the whole document should be rendered. If the selection is empty, nothing should be rendered.

See also
RenderDescriptor, RenderOptions
render
void
render( [in] long  nRenderer,
[in] any  aSelection,
[in] sequence< ::com::sun::star::beans::PropertyValue >  xOptions )
raises( ::com::sun::star::lang::IllegalArgumentException );

Description
renders the object.

renders the object with the specific renderer based on the given selection.

If the selection contains a valid XModel interface, it is assumed that the whole document should be rendered. If the selection is empty, nothing should be rendered.

See also
RenderOptions
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.