ooodev.adapter.awt.uno_control_file_control_model_partial module
- class ooodev.adapter.awt.uno_control_file_control_model_partial.UnoControlFileControlModelPartial(component)[source]
Bases:
UnoControlModelPartial
Partial class for UnoControlFileControlModel.
- Parameters:
component (UnoControlFileControlModel) –
- __init__(component)[source]
Constructor
- Parameters:
component (Any) – Component that implements
com.sun.star.awt.UnoControlFileControlModel
service.
- set_font_descriptor(font_descriptor)[source]
Sets the font descriptor of the control.
- Parameters:
font_descriptor (FontDescriptor, FontDescriptorStructComp) – UNO Struct - Font descriptor to set.
- Return type:
None
Note
The
font_descriptor
property can also be used to set the font descriptor.Hint
FontDescriptor
can be imported fromooo.dyn.awt.font_descriptor
.
- Return type:
None
- Parameters:
font_descriptor (FontDescriptor | FontDescriptorStructComp) –
- property background_color: Color
Gets/Set the background color of the control.
- Returns:
Color
- Return type:
- property border: BorderKind
Gets/Sets the border style of the control.
Note
Value can be set with
BorderKind
orint
.Hint
BorderKind
can be imported fromooodev.utils.kind.border_kind
.
- Return type:
- property border_color: Color | None
Gets/Sets the color of the border, if present
Not every border style (see Border) may support coloring. For instance, usually a border with 3D effect will ignore the border_color setting.
optional
- Returns:
Color or None if not set.
- Return type:
Color | None
- property enabled: bool
Gets/Sets whether the control is enabled or disabled.
- Return type:
bool
- property font_descriptor: FontDescriptorStructComp
Gets/Sets the Font Descriptor.
Setting value can be done with a
FontDescriptor
orFontDescriptorStructComp
object.- Returns:
Font Descriptor
- Return type:
Hint
FontDescriptor
can be imported fromooo.dyn.awt.font_descriptor
.
- property font_emphasis_mark: FontEmphasisEnum
Gets/Sets the
FontEmphasis
value of the text in the control.Note
Value can be set with
FontEmphasisEnum
orint
.Hint
FontEmphasisEnum
can be imported fromooo.dyn.text.font_emphasis
.
- Return type:
FontEmphasisEnum
- property font_relief: FontReliefEnum
Gets/Sets
FontRelief
value of the text in the control.Note
Value can be set with
FontReliefEnum
orint
.Hint
FontReliefEnum
can be imported fromooo.dyn.text.font_relief
.
- Return type:
FontReliefEnum
- property help_text: str
Get/Sets the help text of the control.
- Return type:
str
- property help_url: str
Gets/Sets the help URL of the control.
- Return type:
str
- property hide_inactive_selection: bool | None
Gets/Sets whether the selection in the control should be hidden when the control is not active (focused).
optional
- Return type:
bool | None
- property printable: bool
Gets/Sets that the control will be printed with the document.
- Return type:
bool
- property read_only: bool
Gets/Sets if the content of the control cannot be modified by the user.
- Return type:
bool
- property tabstop: bool
Gets/Sets that the control can be reached with the TAB key.
- Return type:
bool
- property text: str
Gets/Sets the text displayed in the control.
- Return type:
str
- property text_line_color: Color
Gets/Sets the text line color (RGB) of the control.
- Returns:
Color
- Return type:
- property vertical_align: VerticalAlignment | None
Gets/Sets the vertical alignment of the text in the control.
optional
Hint
VerticalAlignment
can be imported fromooo.dyn.style.vertical_alignment
- Return type:
VerticalAlignment | None