Top   Module   Use   Manual   Index 
 INCLUDED SERVICES | EXPORTED INTERFACES | PROPERTIES' SUMMARY | PROPERTIES' DETAILS 

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.


Properties' Summary

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

Properties' Details

Bookmark
 
string Bookmark;
Description
is a generic URL for the property OnClick.
DimColor
 
long DimColor;
Description
This is the color for dimming this shape.

This color is used if the property Shape::DimPrev is true and Shape::DimHide is false .

DimHide
 
boolean DimHide;
Description
If this property and the property 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 Shape::DimColor after executing its animation effect.
Effect
 
com::sun::star::presentation::AnimationEffect Effect;
Description
selects the animation effect of this shape.
IsEmptyPresentationObject
 
[ readonly ] 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
 
com::sun::star::presentation::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
 
com::sun::star::presentation::AnimationSpeed Speed;
Description
This is the speed of the animation effect.
TextEffect
 
com::sun::star::presentation::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 Shape::OnClick .

Top of Page