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 :: presentation ::

service Shape
Description
this service is supported from all shapes inside a PresentationDocument. This usually enahnces objects of type ::com::sun::star::drawing::Shape with presentation properties.
Developers Guide
Drawings - Animations and Interactions

Properties' Summary
string
Bookmark
is a generic URL for the property OnClick.  
::com::sun::star::util::Color
DimColor
This is the color for dimming this shape.  
boolean
DimHide
If this property and the property ::com::sun::star::drawing::Shape::DimPrev are both true, the shape is hidden instead of dimmed to a color.  
boolean
DimPrevious
If this property is true, this shape is dimmed to the color of property ::com::sun::star::drawing::Shape::DimColor after executing its animation effect.  
AnimationEffect
Effect
selects the animation effect of this shape.  
boolean
IsEmptyPresentationObject
If this is a default presentation object and if it is empty, this property is true.  
[ readonly ] boolean
IsPresentationObject
If this is a presentation object, this property is true.  
ClickAction
OnClick
selects an action performed after the user clicks on this shape.  
boolean
PlayFull
If this property is true, the sound of this shape is played in full.  
long
PresentationOrder
This is the position of this shape in the order of the shapes which can be animated on its page.  
string
Sound
This is the URL to a soundfile that is played while the animation effect of this shape is running.  
boolean
SoundOn
If this property is set to true, a sound is played while the animation effect is executed.  
AnimationSpeed
Speed
This is the speed of the animation effect.  
AnimationEffect
TextEffect
This is the animation effect for the text inside this shape.  
long
Verb
specifies an "ole2" verb for the ClickAction VERB in the property ::com::sun::star::drawing::Shape::OnClick.  
Properties' Details
Bookmark
string Bookmark;
Description
is a generic URL for the property OnClick.
DimColor
::com::sun::star::util::Color DimColor;
Description
This is the color for dimming this shape.

This color is used if the property ::com::sun::star::drawing::Shape::DimPrev is true and ::com::sun::star::drawing::Shape::DimHide is false.

DimHide
boolean DimHide;
Description
If this property and the property ::com::sun::star::drawing::Shape::DimPrev are both true, the shape is hidden instead of dimmed to a color.
DimPrevious
boolean DimPrevious;
Description
If this property is true, this shape is dimmed to the color of property ::com::sun::star::drawing::Shape::DimColor after executing its animation effect.
Effect
AnimationEffect Effect;
Description
selects the animation effect of this shape.
IsEmptyPresentationObject
boolean IsEmptyPresentationObject;
Description
If this is a default presentation object and if it is empty, this property is true.
IsPresentationObject
[ readonly ] boolean IsPresentationObject;
Description
If this is a presentation object, this property is true.

Presentation objects are objects like TitleTextShape and OutlinerShape.

OnClick
ClickAction OnClick;
Description
selects an action performed after the user clicks on this shape.
PlayFull
boolean PlayFull;
Description
If this property is true, the sound of this shape is played in full.

The default behavior is to stop the sound after completing the animation effect.

PresentationOrder
long PresentationOrder;
Description
This is the position of this shape in the order of the shapes which can be animated on its page.

The animations are executed in this order, starting at the shape with the PresentationOrder "one." You can change the order by changing this number. Setting it to "one" makes this shape the first shape in the execution order for the animation effects.

Sound
string Sound;
Description
This is the URL to a soundfile that is played while the animation effect of this shape is running.
SoundOn
boolean SoundOn;
Description
If this property is set to true, a sound is played while the animation effect is executed.
Speed
AnimationSpeed Speed;
Description
This is the speed of the animation effect.
TextEffect
AnimationEffect TextEffect;
Description
This is the animation effect for the text inside this shape.
Verb
long Verb;
Description
specifies an "ole2" verb for the ClickAction VERB in the property ::com::sun::star::drawing::Shape::OnClick.

 
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.