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

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

service FillProperties

Description
This is a set of properties to describe the style for rendering an area.


Properties' Summary

FillStyle This enumeration selects the style with which the area will be filled.
FillColor If the FillStyle is set to FillStyle::SOLID , this is the color used.
FillTransparence This is the transparence of the filled area.
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.
FillTransparenceGradient [ OPTIONAL ]
This describes the transparency of the fill area as a gradient.
FillGradientName If the FillStyle is set to FillStyle::GRADIENT , this is the name of the used fill gradient style.
FillGradient [ OPTIONAL ]
If the FillStyle is set to FillStyle::GRADIENT , this describes the gradient used.
FillHatchName If the FillStyle is set to FillStyle::GRADIENT , this is the name of the used fill hatch style.
FillHatch [ OPTIONAL ]
If the FillStyle is set to FillStyle::HATCH , this describes the hatch used.
FillBitmapName If the FillStyle is set to FillStyle::BITMAP , this is the name of the used fill bitmap style.
FillBitmap [ OPTIONAL ]
If the FillStyle is set to FillStyle::BITMAP , this is the bitmap used.
FillBitmapURL [ OPTIONAL ]
If the FillStyle is set to FillStyle::BITMAP , this is a URL to the bitmap used.
FillBitmapOffsetX This is the horizontal offset where the tile starts.
FillBitmapOffsetY This is the vertical offset where the tile starts. It is given in percent in relation to the width of the bitmap.
FillBitmapPositionOffsetX Every second line of tiles is moved the given percent of the witdh of the bitmap.
FillBitmapPositionOffsetY Every second row of tiles is moved the given percent of the width of the bitmap.
FillBitmapRectanglePoint The RectanglePoint specifies the position inside of the bitmap to use as the top left position for rendering.
FillBitmapLogicalSize specifies if the size is given in percentage or as an absolute value.
FillBitmapSizeX This is the width of the tile for filling.
FillBitmapSizeY This is the height of the tile for filling.
FillBitmapMode this enum selects how a area is filled with a single bitmap.
FillBackground if this is true , the transparent background of a hatch filled area is drawn in the current background color

Properties' Details

FillStyle
 
com::sun::star::drawing::FillStyle FillStyle;
Description
This enumeration selects the style with which the area will be filled.
FillColor
 
long FillColor;
Description
If the 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 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;
[ OPTIONAL ]
Description
This describes the transparency of the fill area as a gradient.
FillGradientName
 
string FillGradientName;
Description
If the FillStyle is set to FillStyle::GRADIENT , this is the name of the used fill gradient style.
FillGradient
 
com::sun::star::awt::Gradient FillGradient;
[ OPTIONAL ]
Description
If the FillStyle is set to FillStyle::GRADIENT , this describes the gradient used.
FillHatchName
 
string FillHatchName;
Description
If the FillStyle is set to FillStyle::GRADIENT , this is the name of the used fill hatch style.
FillHatch
 
com::sun::star::drawing::Hatch FillHatch;
[ OPTIONAL ]
Description
If the FillStyle is set to FillStyle::HATCH , this describes the hatch used.
FillBitmapName
 
string FillBitmapName;
Description
If the FillStyle is set to FillStyle::BITMAP , this is the name of the used fill bitmap style.
FillBitmap
 
com::sun::star::awt::XBitmap FillBitmap;
[ OPTIONAL ]
Description
If the FillStyle is set to FillStyle::BITMAP , this is the bitmap used.
FillBitmapURL
 
string FillBitmapURL;
[ OPTIONAL ]
Description
If the FillStyle is set to FillStyle::BITMAP , this is a URL to the bitmap used.
FillBitmapOffsetX
 
short FillBitmapOffsetX;
Description
This is the horizontal offset where the tile starts.

It is given in percent in relation to the width of the bitmap.

FillBitmapOffsetY
 
short FillBitmapOffsetY;
Description
This is the vertical offset where the tile starts. It is given in percent in relation to the width of the bitmap.
FillBitmapPositionOffsetX
 
short FillBitmapPositionOffsetX;
Description
Every second line of tiles is moved the given percent of the witdh of the bitmap.
FillBitmapPositionOffsetY
 
short FillBitmapPositionOffsetY;
Description
Every second row of tiles is moved the given percent of the width of the bitmap.
FillBitmapRectanglePoint
 
com::sun::star::drawing::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
 
com::sun::star::drawing::BitmapMode FillBitmapMode;
Description
this enum selects how a area is filled with a single bitmap.
FillBackground
 
boolean FillBackground;
Description
if this is true , the transparent background of a hatch filled area is drawn in the current background color

Top of Page