Language

The Free and Open Productivity Suite
Released: Apache OpenOffice 4.1.15

API

SDK

Tips ‘n’ Tricks

Miscellaneous

Overview Module Use Devguide Index
Services' Summary Interfaces' Summary Properties' Summary Services' Details Interfaces' Details Properties' Details

:: com :: sun :: star :: drawing ::

service FillProperties
Description
This is a set of properties to describe the style for rendering an area.
Developers Guide
Drawings - General Drawing Properties
Properties' Summary
FillStyle
FillStyle		 This enumeration selects the style the area will be filled with.  
::com::sun::star::util::Color
FillColor		 If the property FillStyle is set to FillStyle::SOLID, this is the color used.  
short
FillTransparence		 This is the transparence of the filled area.  
string
FillTransparenceGradientName		 If a gradient is used for transparency, this is the name of the used transparence gradient style or it is empty. If you set the name of a transparence gradient style contained in the document, this style used.  
::com::sun::star::awt::Gradient
FillTransparenceGradient		 [ OPTIONAL ]
This describes the transparency of the fill area as a gradient.  
string
FillGradientName		 If the property FillStyle is set to FillStyle::GRADIENT, this is the name of the used fill gradient style.  
::com::sun::star::awt::Gradient
FillGradient		 [ OPTIONAL ]
If the property FillStyle is set to FillStyle::GRADIENT, this describes the gradient used.  
string
FillHatchName		 If the property FillStyle is set to FillStyle::HATCH, this is the name of the used fill hatch style.  
Hatch
FillHatch		 [ OPTIONAL ]
If the property FillStyle is set to FillStyle::HATCH, this describes the hatch used.  
boolean
FillBackground		 if this is true, the transparent background of a hatch filled area is drawn in the current background color.  
string
FillBitmapName		 If the property FillStyle is set to FillStyle::BITMAP, this is the name of the used fill bitmap style.  
::com::sun::star::awt::XBitmap
FillBitmap		 [ OPTIONAL ]
If the property FillStyle is set to FillStyle::BITMAP, this is the bitmap used.  
string
FillBitmapURL		 [ OPTIONAL ]
If the property FillStyle is set to FillStyle::BITMAP, this is a URL to the bitmap used.  
short
FillBitmapPositionOffsetX		 This is the horizontal offset where the tile starts.  
short
FillBitmapPositionOffsetY		 This is the vertical offset where the tile starts.  
short
FillBitmapOffsetX		 Every second line of tiles is moved the given percent of the witdh of the bitmap.  
short
FillBitmapOffsetY		 Every second row of tiles is moved the given percent of the height of the bitmap.  
RectanglePoint
FillBitmapRectanglePoint		 The RectanglePoint specifies the position inside of the bitmap to use as the top left position for rendering.  
boolean
FillBitmapLogicalSize		 specifies if the size is given in percentage or as an absolute value.  
long
FillBitmapSizeX		 This is the width of the tile for filling.  
long
FillBitmapSizeY		 This is the height of the tile for filling.  
BitmapMode
FillBitmapMode		 this enum selects how a area is filled with a single bitmap.  
boolean
FillBitmapStretch		 [ OPTIONAL ]
if set, the fill bitmap is stretched to fill the area of the shape.  
boolean
FillBitmapTile		 [ OPTIONAL ]
if set, the fill bitmap is repeated to fill the area of the shape.  
Properties' Details
FillStyle
FillStyle FillStyle;
Description
This enumeration selects the style the area will be filled with.
FillColor
::com::sun::star::util::Color FillColor;
Description
If the property FillStyle is set to FillStyle::SOLID, this is the color used.
FillTransparence
short FillTransparence;
Description
This is the transparence of the filled area.

This property is only valid if the property FillStyle is set to FillStyle::SOLID.

FillTransparenceGradientName
string FillTransparenceGradientName;
Description
If a gradient is used for transparency, this is the name of the used transparence gradient style or it is empty. If you set the name of a transparence gradient style contained in the document, this style used.
FillTransparenceGradient
::com::sun::star::awt::Gradient FillTransparenceGradient;
Usage Restrictions
optional
Description
This describes the transparency of the fill area as a gradient.
FillGradientName
string FillGradientName;
Description
If the property FillStyle is set to FillStyle::GRADIENT, this is the name of the used fill gradient style.
FillGradient
::com::sun::star::awt::Gradient FillGradient;
Usage Restrictions
optional
Description
If the property FillStyle is set to FillStyle::GRADIENT, this describes the gradient used.
FillHatchName
string FillHatchName;
Description
If the property FillStyle is set to FillStyle::HATCH, this is the name of the used fill hatch style.
FillHatch
Hatch FillHatch;
Usage Restrictions
optional
Description
If the property FillStyle is set to FillStyle::HATCH, this describes the hatch used.
FillBackground
boolean FillBackground;
Description
if this is true, the transparent background of a hatch filled area is drawn in the current background color.
FillBitmapName
string FillBitmapName;
Description
If the property FillStyle is set to FillStyle::BITMAP, this is the name of the used fill bitmap style.
FillBitmap
::com::sun::star::awt::XBitmap FillBitmap;
Usage Restrictions
optional
Description
If the property FillStyle is set to FillStyle::BITMAP, this is the bitmap used.
FillBitmapURL
string FillBitmapURL;
Usage Restrictions
optional
Description
If the property FillStyle is set to FillStyle::BITMAP, this is a URL to the bitmap used.
FillBitmapPositionOffsetX
short FillBitmapPositionOffsetX;
Description
This is the horizontal offset where the tile starts.

It is given in percent in relation to the width of the bitmap.
FillBitmapPositionOffsetY
short FillBitmapPositionOffsetY;
Description
This is the vertical offset where the tile starts.

It is given in percent in relation to the height of the bitmap.
FillBitmapOffsetX
short FillBitmapOffsetX;
Description
Every second line of tiles is moved the given percent of the witdh of the bitmap.
FillBitmapOffsetY
short FillBitmapOffsetY;
Description
Every second row of tiles is moved the given percent of the height of the bitmap.
FillBitmapRectanglePoint
RectanglePoint FillBitmapRectanglePoint;
Description
The RectanglePoint specifies the position inside of the bitmap to use as the top left position for rendering.
FillBitmapLogicalSize
boolean FillBitmapLogicalSize;
Description
specifies if the size is given in percentage or as an absolute value.

If this is true, the properties FillBitmapSizeX and FillBitmapSizeY contain the size of the tile in percent of the size of the original bitmap. If this is false, the size of the tile is specified with 1/100th mm.

FillBitmapSizeX
long FillBitmapSizeX;
Description
This is the width of the tile for filling.

Depending on the property FillBitmapLogicalSize, this is either relative or absolute.

FillBitmapSizeY
long FillBitmapSizeY;
Description
This is the height of the tile for filling.

Depending on the property FillBitmapLogicalSize, this is either relative or absolute.

FillBitmapMode
BitmapMode FillBitmapMode;
Description
this enum selects how a area is filled with a single bitmap.

This property corresponds to the properties FillBitmapStretch and FillBitmapTile.

If set to BitmapMode::REPEAT, the property FillBitmapStretch is set to false, and the property FillBitmapTile is set to true.

If set to BitmapMode::STRETCH, the property FillBitmapStretch is set to true, and the property FillBitmapTile is set to false.

If set to BitmapMode::NO_REPEAT, both properties FillBitmapStretch and FillBitmapTile are set to false.
FillBitmapStretch
boolean FillBitmapStretch;
Usage Restrictions
optional
Description
if set, the fill bitmap is stretched to fill the area of the shape.

This property should not be used anymore and is included here for completeness. The FillBitmapMode property can be used instead to set all supported bitmap modes.

If set to true, the value of the FillBitmapMode property changes to BitmapMode::STRETCH. BUT: behaviour is undefined, if the property FillBitmapTile is true too.

If set to false, the value of the FillBitmapMode property changes to BitmapMode::REPEAT or BitmapMode::NO_REPEAT, depending on the current value of the FillBitmapTile property.
FillBitmapTile
boolean FillBitmapTile;
Usage Restrictions
optional
Description
if set, the fill bitmap is repeated to fill the area of the shape.

This property should not be used anymore and is included here for completeness. The FillBitmapMode property can be used instead to set all supported bitmap modes.

If set to true, the value of the FillBitmapMode property changes to BitmapMode::REPEAT. BUT: behaviour is undefined, if the property FillBitmapStretch is true too.

If set to false, the value of the FillBitmapMode property changes to BitmapMode::STRETCH or BitmapMode::NO_REPEAT, depending on the current value of the FillBitmapStretch property.

 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.