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

service GenericDrawPage
Description
This abstract service is implemented by every page of a DrawingDocument.
Example
create and insert a couple of LineShapes:
 xPage = xDoc.DrawPages(0)
 for x% = 0 to 200
 xShape = xProv.createInstance( "com::sun::star::drawing::LineShape" )
 xShape.LineColor = rgb( 255, 0, n%+20 )
 xShape.LineWidth = 20
 xShape.Position = Point( x%, 2*x% )
 xShape.Size = Size( 300-x%, 20 )
 xPage.add( xShape )
 next x%
 
Developers Guide
Drawings - Page Formatting

Exported Interfaces - Summary
XShapes

manages the Shapes of this page. (details)

XShapeGrouper

With this interface you can group/ungroup a collection of Shapes.

XShapeCombiner

With this interface you can combine/split a collection of Shapes. (details)

XShapeBinder

With this interface you can bind/unbind a collection of Shapes. (details)

::com::sun::star::container::XNamed

Gets or sets the name of this page. (details)

::com::sun::star::lang::XServiceInfo

returns the services implemented by this instance.

::com::sun::star::beans::XPropertySet

gives you access to the properties of this DrawPage. (details)

Properties' Summary
long
BorderBottom
[ OPTIONAL ]
This is the border at the bottom.  
long
BorderLeft
[ OPTIONAL ]
This is the border at the left.  
long
BorderRight
[ OPTIONAL ]
This is the border at the right.  
long
BorderTop
[ OPTIONAL ]
This is the border at the top.  
long
Height
[ OPTIONAL ]
This is the height.  
long
Width
[ OPTIONAL ]
This is the width.  
[ readonly ] short
Number
[ OPTIONAL ]
This is the number of this page, starting with 1.  
::com::sun::star::view::PaperOrientation
Orientation
[ OPTIONAL ]
This is the orientation of this page.  
::com::sun::star::container::XNameContainer
UserDefinedAttributes
[ OPTIONAL ]
this property stores xml attributes. They will be saved to and restored from automatic styles inside xml files.  
[ readonly ] boolean
IsBackgroundDark
[ OPTIONAL ]
this property is true if the avveraged background filling colors luminance is belove an application specified threshold value. This can be used to determine the actuall value of an auto color.  
::com::sun::star::container::XIndexAccess
NavigationOrder
[ OPTIONAL ]
this index access defines a navigation order for the top level shapes inside this page. By default this is equal to the index access of the slide itself, making the z-order the default navigation order for top level shapes.  
Exported Interfaces - Details
XShapes
Description
manages the Shapes of this page.

It also lets you add new Shapes. The program currently requires that these Shapes be created by the factory of the document.

See also
DrawingDocument
XShapeGrouper
Description
With this interface you can group/ungroup a collection of Shapes.
XShapeCombiner
Usage Restrictions
optional
Description
With this interface you can combine/split a collection of Shapes.
XShapeBinder
Usage Restrictions
optional
Description
With this interface you can bind/unbind a collection of Shapes.
::com::sun::star::container::XNamed
Usage Restrictions
optional
Description
Gets or sets the name of this page.

Duplicated pagenames inside a document are not allowed.

::com::sun::star::lang::XServiceInfo
Description
returns the services implemented by this instance.
::com::sun::star::beans::XPropertySet
Usage Restrictions
optional
Description
gives you access to the properties of this DrawPage.
Properties' Details
BorderBottom
long BorderBottom;
Usage Restrictions
optional
Description
This is the border at the bottom.
BorderLeft
long BorderLeft;
Usage Restrictions
optional
Description
This is the border at the left.
BorderRight
long BorderRight;
Usage Restrictions
optional
Description
This is the border at the right.
BorderTop
long BorderTop;
Usage Restrictions
optional
Description
This is the border at the top.
Height
long Height;
Usage Restrictions
optional
Description
This is the height.
Width
long Width;
Usage Restrictions
optional
Description
This is the width.
Number
[ readonly ] short Number;
Usage Restrictions
optional
Description
This is the number of this page, starting with 1.
Orientation
::com::sun::star::view::PaperOrientation Orientation;
Usage Restrictions
optional
Description
This is the orientation of this page.
UserDefinedAttributes
::com::sun::star::container::XNameContainer UserDefinedAttributes;
Usage Restrictions
optional
Description
this property stores xml attributes. They will be saved to and restored from automatic styles inside xml files.
See also
::com::sun::star::xml::AttributeContainer
IsBackgroundDark
[ readonly ] boolean IsBackgroundDark;
Usage Restrictions
optional
Description
this property is true if the avveraged background filling colors luminance is belove an application specified threshold value. This can be used to determine the actuall value of an auto color.
NavigationOrder
::com::sun::star::container::XIndexAccess NavigationOrder;
Usage Restrictions
optional
Description
this index access defines a navigation order for the top level shapes inside this page. By default this is equal to the index access of the slide itself, making the z-order the default navigation order for top level shapes.

 
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.