Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Methods' Summary Attributes' Summary Methods' Details Attributes' Details

:: com :: sun :: star :: report ::

interface XImageControl
Base Interfaces
XImageControl
┣ XReportControlModel
┃ ┣ XReportComponent
┃ ┃ ┣ ::com::sun::star::util::XCloneable
┃ ┃ ┣ ::com::sun::star::container::XChild
┃ ┃ ┣ ::com::sun::star::lang::XComponent
┃ ┃ ┣ ::com::sun::star::drawing::XShape
┃ ┃ ┃ ┗ ::com::sun::star::drawing::XShapeDescriptor
┃ ┃ ┗ ::com::sun::star::beans::XPropertySet
┃ ┣ XReportControlFormat
┃ ┣ ::com::sun::star::container::XContainer
┃ ┗ ::com::sun::star::container::XIndexContainer
┃    ┗ ::com::sun::star::container::XIndexReplace
┃       ┗ ::com::sun::star::container::XIndexAccess
┃          ┗ ::com::sun::star::container::XElementAccess
┗ ::com::sun::star::form::XImageProducerSupplier
XReportControlModel
(referenced interface's summary:)
::com::sun::star::form::XImageProducerSupplier
Description
supplies the caller with an ::com::sun::star::awt::XImageProducer.

Other components can register as ::com::sun::star::awt::XImageConsumer at this producer. Then they will be notified of any change in the image to be displayed.

Whenever the ::com::sun::star::awt::UnoControlImageControlModel::ImageURL property is changed, the model loads the specified image, and sets it as image source at its ::com::sun::star::awt::XImageProducer. Then, all ::com::sun::star::awt::XImageConsumers are notified and supplied with the binary data of the image.
Usually, controls acting for an ImageControl model are consumers, and use the data stream to display the image
Attributes' Summary
ImageURL specifies an URL to an image to use for the control.  
ScaleMode defines how to scale the image  
PreserveIRI Specifies that the IRI given in the data field should be preserved, otherwise the content will be inserted in the resulting report document. If the data field contains something different as string then this attribute will be ignored.  
Attributes' Details
ImageURL
[ bound ] string ImageURL;
Description
specifies an URL to an image to use for the control.
ScaleMode
[ bound ] short ScaleMode
set raises (::com::sun::star::lang::IllegalArgumentException);
Description
defines how to scale the image

If this property is present, it supersedes the ScaleImage property.

The value of this property is one of the ::com::sun::star::awt::ImageScaleMode constants.

Since
OOo 3.2
PreserveIRI
[ bound ] boolean PreserveIRI;
Description
Specifies that the IRI given in the data field should be preserved, otherwise the content will be inserted in the resulting report document. If the data field contains something different as string then this attribute will be ignored.
Top of Page

Copyright © 2013, The Apache Software Foundation, Licensed under the Apache License, Version 2.0. Apache, the Apache feather logo, Apache OpenOffice and OpenOffice.org are trademarks of The Apache Software Foundation. Other names may be trademarks of their respective owners.

Apache Software Foundation

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

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