Properties' Summary |
short
Align |
[ OPTIONAL ]
specifies the horizontal alignment of the text in the control.
|
::com::sun::star::util::Color
BackgroundColor |
specifies the background color (RGB) of the control.
|
boolean
DefaultButton |
specifies that the button is the default button on the document.
|
boolean
Enabled |
determines whether the control is enabled or disabled.
|
boolean
FocusOnClick |
[ OPTIONAL ]
specifies whether the button control should grab the focus when clicked.
|
FontDescriptor
FontDescriptor |
specifies the font attributes of the text in the control.
|
short
FontEmphasisMark |
specifies the ::com::sun::star::text::FontEmphasis
value of the text in the control.
|
short
FontRelief |
specifies the ::com::sun::star::text::FontRelief
value of the text in the control.
|
string
HelpText |
specifies the help text of the control.
|
string
HelpURL |
specifies the help URL of the control.
|
short
ImageAlign |
specifies the alignment of the image inside the button as
ImageAlign value.
|
short
ImagePosition |
[ OPTIONAL ]
specifies the position of the image, if any, relative to the text, if any
|
string
ImageURL |
specifies an URL to an image to use for the button.
|
[ transient ] ::com::sun::star::graphic::XGraphic
Graphic |
[ OPTIONAL ]
specifies a graphic to be displayed at the button
|
string
Label |
specifies the label of the control.
|
boolean
MultiLine |
[ OPTIONAL ]
specifies that the text may be displayed on more than one line.
|
boolean
Printable |
specifies that the control will be printed with the document.
|
short
PushButtonType |
specifies the default action of the button as PushButtonType value.
|
boolean
Repeat |
[ OPTIONAL ]
specifies whether the control should show repeating behaviour.
|
long
RepeatDelay |
[ OPTIONAL ]
specifies the mouse repeat delay, in milliseconds.
|
short
State |
specifies the state of the control.
|
boolean
Tabstop |
specifies that the control can be reached with the TAB key.
|
::com::sun::star::util::Color
TextColor |
specifies the text color (RGB) of the control.
|
::com::sun::star::util::Color
TextLineColor |
specifies the text line color (RGB) of the control.
|
boolean
Toggle |
[ OPTIONAL ]
specifies whether the button should toggle on a single operation.
|
::com::sun::star::style::VerticalAlignment
VerticalAlign |
[ OPTIONAL ]
specifies the vertical alignment of the text in the control.
|
Properties' Details |
Align
short Align;
- Usage Restrictions
- optional
- Description
- specifies the horizontal alignment of the text in the control.
0: left
1: center
2: right
|
|
BackgroundColor
::com::sun::star::util::Color BackgroundColor;
- Description
- specifies the background color (RGB) of the control.
|
|
DefaultButton
boolean DefaultButton;
- Description
- specifies that the button is the default button on the document.
|
|
Enabled
boolean Enabled;
- Description
- determines whether the control is enabled or disabled.
|
|
FocusOnClick
boolean FocusOnClick;
- Usage Restrictions
- optional
- Description
- specifies whether the button control should grab the focus when clicked.
If set to true (which is the default), the button control automatically grabs the
focus when the user clicks onto it with the mouse.
If set to false, the focus is preserved when the user operates the button control with
the mouse.
- Since
- OOo 2.0
|
|
FontDescriptor
FontDescriptor FontDescriptor;
- Description
- specifies the font attributes of the text in the control.
|
|
FontEmphasisMark
short FontEmphasisMark;
- Description
- specifies the ::com::sun::star::text::FontEmphasis
value of the text in the control.
|
|
FontRelief
short FontRelief;
- Description
- specifies the ::com::sun::star::text::FontRelief
value of the text in the control.
|
|
HelpText
string HelpText;
- Description
- specifies the help text of the control.
|
|
HelpURL
string HelpURL;
- Description
- specifies the help URL of the control.
|
|
ImageAlign
short ImageAlign;
- Description
- specifies the alignment of the image inside the button as
ImageAlign value.
|
|
ImagePosition
short ImagePosition;
- Usage Restrictions
- optional
- Description
- specifies the position of the image, if any, relative to the text, if any
Valid values of this property are specified with ImagePosition.
If this property is present, it supersedes the ImageAlign property - setting
one of both properties sets the other one to the best possible match.
|
|
ImageURL
string ImageURL;
- Description
- specifies an URL to an image to use for the button.
- See also
- Graphic
|
|
Graphic
[ transient ] ::com::sun::star::graphic::XGraphic Graphic;
- Usage Restrictions
- optional
- Description
- specifies a graphic to be displayed at the button
If this property is present, it interacts with the ImageURLin the
following way:
- If ImageURL is set, Graphic will be reset
to an object as loaded from the given image URL, or NULL if ImageURL
does not point to a valid image file.
- If Graphic is set, ImageURL will be reset
to an empty string.
- Since
- OOo 2.1
|
|
Label
string Label;
- Description
- specifies the label of the control.
|
|
MultiLine
boolean MultiLine;
- Usage Restrictions
- optional
- Description
- specifies that the text may be displayed on more than one line.
- Since
- OOo 2.0
|
|
Printable
boolean Printable;
- Description
- specifies that the control will be printed with the document.
|
|
PushButtonType
short PushButtonType;
- Description
- specifies the default action of the button as PushButtonType value.
|
|
Repeat
boolean Repeat;
- Usage Restrictions
- optional
- Description
- specifies whether the control should show repeating behaviour.
Normally, when you click a button with the mouse, you need to
release the mouse button, and press it again. With this property
set to true, the button is repeatedly pressed while you hold
down the mouse button.
- Since
- OOo 2.0
|
|
RepeatDelay
long RepeatDelay;
- Usage Restrictions
- optional
- Description
- specifies the mouse repeat delay, in milliseconds.
When the user presses a mouse in a control area where this triggers
an action (such as pressing the button), then usual control implementations
allow to repeatedly trigger this action, without the need to release the
mouse button and to press it again. The delay between two such triggers
is specified with this property.
- Since
- OOo 2.0
|
|
State
short State;
- Description
- specifies the state of the control.
|
|
Tabstop
boolean Tabstop;
- Description
- specifies that the control can be reached with the TAB key.
|
|
TextColor
::com::sun::star::util::Color TextColor;
- Description
- specifies the text color (RGB) of the control.
|
|
TextLineColor
::com::sun::star::util::Color TextLineColor;
- Description
- specifies the text line color (RGB) of the control.
|
|
Toggle
boolean Toggle;
- Usage Restrictions
- optional
- Description
- specifies whether the button should toggle on a single operation.
If this property is set to true, a single operation of the button control (pressing space
while it is focused, or clicking onto it) toggles it between a pressed and a not
pressed state.
The default for this property is false, which means the button behaves like a usual
push button.
- Since
- OOo 2.0
|
|
VerticalAlign
::com::sun::star::style::VerticalAlignment VerticalAlign;
- Usage Restrictions
- optional
- Description
- specifies the vertical alignment of the text in the control.
- Since
- OOo 2.0
|
|
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.