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

interface XRenderable
Base Hierarchy
::com::sun::star::uno::XInterface
 |
 +-XRenderable
Description
represents something that can be rendered.
Since version
OpenOffice.org 1.1

Methods' Summary
getRendererCount
getRenderer
render renders the object.
Methods' Details
getRendererCount
long
getRendererCount(
 
[in] any
[in] sequence< ::com::sun::star::beans::PropertyValue

raises(

 
aSelection,
xOptions ) 
::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
[in] any
[in] sequence< ::com::sun::star::beans::PropertyValue

raises(

 
nRenderer,
aSelection,
xOptions ) 
::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
See also
RenderOptions
render
void
render(
 
[in] long
[in] any
[in] sequence< ::com::sun::star::beans::PropertyValue

raises(

 
nRenderer,
aSelection,
xOptions ) 
::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