xtd::forms::label_renderer Class Reference

Definition

Provides label control renderer methods.

class forms_export_ label_renderer static_

Inheritance

xtd::static → xtd::forms::label_renderer

Header

#include <xtd/forms/label_renderer> 

Namespace

xtd::forms::style_sheets

Library

xtd.forms

Static Public Member Functions
static void	draw_label (const xtd::forms::style_sheets::style_sheet &style_sheet, xtd::drawing::graphics &graphics, const xtd::drawing::rectangle &bounds, xtd::forms::visual_styles::label_state label_state, const std::optional< xtd::drawing::color > &back_color, const xtd::ustring &text, const std::optional< xtd::forms::content_alignment > &text_align, const std::optional< xtd::drawing::color > &fore_color, const std::optional< xtd::drawing::font > &font, const xtd::drawing::image &image, const std::optional< xtd::forms::content_alignment > &image_align, const std::optional< xtd::forms::border_style > &border, xtd::forms::border_sides sides, const std::vector< xtd::forms::shadow > &shadows, bool auto_ellipsis)
	Draws a box in the specified bounds, label style, label state and background color. More...
static void	draw_link_label (const xtd::forms::style_sheets::style_sheet &style_sheet, xtd::drawing::graphics &graphics, const xtd::drawing::rectangle &bounds, xtd::forms::visual_styles::link_label_state link_label_state, const std::optional< xtd::drawing::color > &back_color, const xtd::ustring &text, const std::vector< xtd::forms::link > &links, const std::optional< xtd::forms::content_alignment > &text_align, const std::optional< xtd::drawing::color > &fore_color, const std::optional< xtd::drawing::color > &link_color, const std::optional< xtd::drawing::color > &visited_link_color, const std::optional< xtd::drawing::font > &font, xtd::forms::link_behavior link_behavior, const xtd::drawing::image &image, const std::optional< xtd::forms::content_alignment > &image_align, const std::optional< xtd::forms::border_style > &border, xtd::forms::border_sides sides, const std::vector< xtd::forms::shadow > &shadows, bool auto_ellipsis)
	Draws a box in the specified bounds, label style, label state and background color. More...

Member Function Documentation

draw_label()

static void xtd::forms::label_renderer::draw_label ( const xtd::forms::style_sheets::style_sheet &  style_sheet, xtd::drawing::graphics &  graphics, const xtd::drawing::rectangle &  bounds, xtd::forms::visual_styles::label_state  label_state, const std::optional< xtd::drawing::color > &  back_color, const xtd::ustring &  text, const std::optional< xtd::forms::content_alignment > &  text_align, const std::optional< xtd::drawing::color > &  fore_color, const std::optional< xtd::drawing::font > &  font, const xtd::drawing::image &  image, const std::optional< xtd::forms::content_alignment > &  image_align, const std::optional< xtd::forms::border_style > &  border, xtd::forms::border_sides  sides, const std::vector< xtd::forms::shadow > &  shadows, bool  auto_ellipsis  )

static

Draws a box in the specified bounds, label style, label state and background color.

Parameters

style_sheet	The xtd::forms::style_sheets::style_sheet used to draw a label.
graphics	The xtd::drawing::graphics used to draw a label.
bounds	The xtd::drawing::rectangle that specifies the bounds of the label.
label_state	The visual state of a label that is drawn with visual styles.
back_color	The background color for the label control.
text	The text of the label control.
text_flags	Contains the display and layout information for text strings.
fore_color	The foreground color for the label control.
font	The font of the text for the label control.
image	The image of the label control.
image_align	Contains the display and layout information for image .
border	Contains the border style for the control
side	Contains the border sides for the control.
shadows	An xtd::forms::shadow array used to draw shadows under the text.
auto_ellipsis	The value indicating whether the ellipsis character (...) appears at the right edge of the xtd::forms::label, denoting that the xtd::forms::label text extends beyond the specified length of the xtd::forms::label.

Remarks

The parameter back_color is set only if they are different from its default value; otherwise std::nullopt.

draw_link_label()

static void xtd::forms::label_renderer::draw_link_label ( const xtd::forms::style_sheets::style_sheet &  style_sheet, xtd::drawing::graphics &  graphics, const xtd::drawing::rectangle &  bounds, xtd::forms::visual_styles::link_label_state  link_label_state, const std::optional< xtd::drawing::color > &  back_color, const xtd::ustring &  text, const std::vector< xtd::forms::link > &  links, const std::optional< xtd::forms::content_alignment > &  text_align, const std::optional< xtd::drawing::color > &  fore_color, const std::optional< xtd::drawing::color > &  link_color, const std::optional< xtd::drawing::color > &  visited_link_color, const std::optional< xtd::drawing::font > &  font, xtd::forms::link_behavior  link_behavior, const xtd::drawing::image &  image, const std::optional< xtd::forms::content_alignment > &  image_align, const std::optional< xtd::forms::border_style > &  border, xtd::forms::border_sides  sides, const std::vector< xtd::forms::shadow > &  shadows, bool  auto_ellipsis  )

static

Draws a box in the specified bounds, label style, label state and background color.

Parameters

style_sheet	The xtd::forms::style_sheets::style_sheet used to draw a label.
graphics	The xtd::drawing::graphics used to draw a label.
bounds	The xtd::drawing::rectangle that specifies the bounds of the label.
label_state	The visual state of a label that is drawn with visual styles.
back_color	The background color for the label control.
text	The text of the label control.
text_flags	Contains the display and layout information for text strings.
fore_color	The foreground color for the label control.
font	The font of the text for the label control.
image	The image of the label control.
image_align	Contains the display and layout information for image .
border	Contains the border style for the control
side	Contains the border sides for the control.
shadows	An xtd::forms::shadow array used to draw shadows under the text.
auto_ellipsis	The value indicating whether the ellipsis character (...) appears at the right edge of the xtd::forms::label, denoting that the xtd::forms::label text extends beyond the specified length of the xtd::forms::label.

Remarks

The parameter back_color is set only if they are different from its default value; otherwise std::nullopt.

---

The documentation for this class was generated from the following file:

• xtd.forms/include/xtd/forms/label_renderer.h