LayOut C API

- Main Page
- Related Pages
- Data Structures
- Files

- File List
- Globals

All Data Structures Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Enumerations | Functions
style.h File Reference
`#include <LayOutAPI/common.h>`
`#include <LayOutAPI/model/defs.h>`
`#include <LayOutAPI/geometry/geometry.h>`
`#include <SketchUpAPI/color.h>`

Go to the source code of this file.

## Enumerations
enum | LOStrokeJoinStyle { LOStrokeJoinStyle_Miter = 0, LOStrokeJoinStyle_Round, LOStrokeJoinStyle_Bevel, LONumStrokeJoinStyles }
| Defines how to draw the connection between two segments of a path's stroke. More...
enum | LOStrokeCapStyle { LOStrokeCapStyle_Flat = 0, LOStrokeCapStyle_Round, LOStrokeCapStyle_Square, LONumStrokeCapStyles }
| Defines how to draw the end-caps of a path's stroke. More...
enum | LOStrokePattern { LOStrokePattern_Solid = 0, LOStrokePattern_Dash, LOStrokePattern_Dot, LOStrokePattern_DashDot, LOStrokePattern_DashDotDot, LOStrokePattern_DashSpace, LOStrokePattern_DashDotDotDot, LOStrokePattern_DashDashDot, LOStrokePattern_DashDashDotDot, LOStrokePattern_DashDashDotDotDot, LOStrokePattern_Center, LOStrokePattern_Phantom, LOStrokePattern_ShortDash, LONumStrokePatterns }
| Defines the stippling pattern of a path's stroke. More...
enum | LOTextUnderline { LOTextUnderline_None = 0, LOTextUnderline_Single, LOTextUnderline_Double, LONumTextUnderlines }
| Defines underline styles for formatted text. More...
enum | LOTextStrikeThrough { LOTextStrikeThrough_None = 0, LOTextStrikeThrough_Single, LONumTextStrikeThroughs }
| Defines strike through styles for formatted text. More...
enum | LOTextElevation { LOTextElevation_Normal = 0, LOTextElevation_Superscript, LOTextElevation_Subscript, LONumTextElevations }
| Defines super/subscript options for formatted text. More...
enum | LOTextAlignment { LOTextAlignment_Left = 0, LOTextAlignment_Right, LOTextAlignment_Center, LONumTextAlignments }
| Defines left/right/center text alignment for formatted text. More...
enum | LOTextAnchor { LOTextAnchor_Top = 0, LOTextAnchor_Center, LOTextAnchor_Bottom, LONumTextAnchors }
| Defines top/center/bottom text anchoring for formatted text. More...
enum | LODimensionRotationAlignment { LODimensionRotationAlignment_Horizontal = 0, LODimensionRotationAlignment_Vertical, LODimensionRotationAlignment_Align, LODimensionRotationAlignment_Perpendicular, LONumDimensionRotationAlignments }
| Represents how the dimension text is oriented on the page. More...
enum | LODimensionVerticalAlignment { LODimensionVerticalAlignment_Above = 0, LODimensionVerticalAlignment_Center, LODimensionVerticalAlignment_Below, LODimensionVerticalAlignment_Offset, LONumDimensionVerticalAlignments }
| Represents how the dimension text is positioned. The position is relative to the dimension line. LODimensionVerticalAlignment_Offset indicates that the text box position is based on a custom offset. More...
enum | LODimensionUnits { LODimensionUnits_FractionalInches = 0, LODimensionUnits_ArchitecturalInches, LODimensionUnits_EngineeringFeet, LODimensionUnits_DecimalInches, LODimensionUnits_DecimalFeet, LODimensionUnits_DecimalMillimeters, LODimensionUnits_DecimalCentimeters, LODimensionUnits_DecimalMeters, LODimensionUnits_DecimalPoints, LODimensionUnits_Degrees, LODimensionUnits_Radians, LONumDimensionUnits }
| Defines the different units formats that are available for linear and angular dimensions. More...
enum | LOArrowType { LOArrowType_None = 0, LOArrowType_FilledTriangle, LOArrowType_OpenTriangle, LOArrowType_FilledSkinnyTriangle, LOArrowType_OpenSkinnyTriangle, LOArrowType_OpenArrow90, LOArrowType_OpenArrow120, LOArrowType_FilledCircle, LOArrowType_OpenCircle, LOArrowType_FilledSquare, LOArrowType_OpenSquare, LOArrowType_FilledDiamond, LOArrowType_OpenDiamond, LOArrowType_Star, LOArrowType_T, LOArrowType_SlashRight, LOArrowType_SlashLeft, LOArrowType_Underrun, LOArrowType_Overrun, LONumArrowTypes }
| Defines the arrowhead types available for a path entity. More...
enum | LOSubEntityType { LOSubEntityType_LabelLeaderLine = 0, LOSubEntityType_LabelText, LOSubEntityType_DimensionStartExtensionLine, LOSubEntityType_DimensionEndExtensionLine, LOSubEntityType_DimensionDimensionLine, LOSubEntityType_DimensionLeaderLine, LOSubEntityType_DimensionText, LONumSubEntityTypes }
| Defines the types of sub entity that may have style attributes applied directly to them. More...

## Functions
LO_RESULT | LOStyleCreate (LOStyleRef *style)
| Creates a new empty style object. More...
LO_RESULT | LOStyleRelease (LOStyleRef *style)
| Releases a style object. *style will be set to invalid by this function. More...
LO_RESULT | LOStyleCopy (LOStyleRef src_style, LOStyleRef dst_style)
| Copies the style attributes from one style object to another. More...
LO_RESULT | LOStyleGetStroked (LOStyleRef style, bool *is_stroked)
| Gets whether or not a style has a stroke. More...
LO_RESULT | LOStyleSetStroked (LOStyleRef style, bool is_stroked)
| Sets whether or not a style has a stroke. More...
LO_RESULT | LOStyleGetStrokeWidth (LOStyleRef style, double *stroke_width)
| Gets the stroke width of a style. More...
LO_RESULT | LOStyleSetStrokeWidth (LOStyleRef style, double stroke_width)
| Sets the stroke width of a style. More...
LO_RESULT | LOStyleGetStrokeColor (LOStyleRef style, SUColor *stroke_color)
| Gets the stroke color of a style. More...
LO_RESULT | LOStyleSetStrokeColor (LOStyleRef style, SUColor stroke_color)
| Sets the stroke color of a style. More...
LO_RESULT | LOStyleGetStrokeJoinStyle (LOStyleRef style, LOStrokeJoinStyle *join_type)
| Gets the stroke join style of a style. More...
LO_RESULT | LOStyleSetStrokeJoinStyle (LOStyleRef style, LOStrokeJoinStyle join_type)
| Sets the stroke join style of a style. More...
LO_RESULT | LOStyleGetStrokeCapStyle (LOStyleRef style, LOStrokeCapStyle *cap_type)
| Gets the stroke cap style of a style. More...
LO_RESULT | LOStyleSetStrokeCapStyle (LOStyleRef style, LOStrokeCapStyle cap_type)
| Sets the stroke cap style of a style. More...
LO_RESULT | LOStyleGetStrokePattern (LOStyleRef style, LOStrokePattern *stroke_pattern)
| Gets the stroke pattern of a style. More...
LO_RESULT | LOStyleSetStrokePattern (LOStyleRef style, LOStrokePattern stroke_pattern)
| Sets the stroke pattern of a style. More...
LO_RESULT | LOStyleGetStrokePatternScale (LOStyleRef style, double *pattern_scale)
| Gets the stroke pattern scale of a style. More...
LO_RESULT | LOStyleSetStrokePatternScale (LOStyleRef style, double pattern_scale)
| Sets the stroke pattern scale of a style. More...
LO_RESULT | LOStyleGetSolidFilled (LOStyleRef style, bool *solid_filled)
| Gets whether or not a style has a solid color fill. More...
LO_RESULT | LOStyleSetSolidFilled (LOStyleRef style, bool solid_filled)
| Sets whether or not a style has a solid color fill. More...
LO_RESULT | LOStyleGetSolidFillColor (LOStyleRef style, SUColor *fill_color)
| Gets the solid fill color of a style. More...
LO_RESULT | LOStyleSetSolidFillColor (LOStyleRef style, SUColor fill_color)
| Sets the solid fill color of a style. More...
LO_RESULT | LOStyleGetPatternFilled (LOStyleRef style, bool *pattern_filled)
| Gets whether there is a pattern fill or not of a style. More...
LO_RESULT | LOStyleSetPatternFilled (LOStyleRef style, bool pattern_filled)
| Sets whether or not a style has a pattern fill. More...
LO_RESULT | LOStyleGetPatternFillImagePath (LOStyleRef style, SUStringRef *image_path)
| Gets the pattern fill image path of a style. This is the file path for the pattern fill image file reference. More...
LO_RESULT | LOStyleSetPatternFillImagePath (LOStyleRef style, const char *image_path)
| Sets the pattern fill image path of a style. This is the file path for the pattern fill image file reference. More...
LO_RESULT | LOStyleGetPatternFillRotation (LOStyleRef style, double *rotation)
| Gets the rotation angle applied to the pattern fill of a style. More...
LO_RESULT | LOStyleSetPatternFillRotation (LOStyleRef style, double rotation)
| Sets the rotation angle applied to the pattern fill of a style. More...
LO_RESULT | LOStyleGetPatternFillScale (LOStyleRef style, double *scale)
| Gets the scale applied to the pattern fill of a style. More...
LO_RESULT | LOStyleSetPatternFillScale (LOStyleRef style, double scale)
| Sets the scale applied to the pattern fill of a style. More...
LO_RESULT | LOStyleGetPatternFillOrigin (LOStyleRef style, LOPoint2D *origin)
| Gets the origin for the pattern fill of a style. More...
LO_RESULT | LOStyleSetPatternFillOrigin (LOStyleRef style, const LOPoint2D *origin)
| Sets the origin for the pattern fill of a style. More...
LO_RESULT | LOStyleGetTextFontFamily (LOStyleRef style, SUStringRef *family)
| Gets the text font name of a style. More...
LO_RESULT | LOStyleSetTextFontFamily (LOStyleRef style, const char *family)
| Sets the text font name of a style. More...
LO_RESULT | LOStyleGetTextBold (LOStyleRef style, bool *is_bold)
| Gets whether or not text should be bold for a style. More...
LO_RESULT | LOStyleSetTextBold (LOStyleRef style, bool is_bold)
| Sets whether or not text should be bold for a style. More...
LO_RESULT | LOStyleGetTextItalic (LOStyleRef style, bool *is_italic)
| Gets whether or not text should be italicized for a style. More...
LO_RESULT | LOStyleSetTextItalic (LOStyleRef style, bool is_italic)
| Sets whether or not text should be italicized for a style. More...
LO_RESULT | LOStyleGetFontSize (LOStyleRef style, double *size_in_points)
| Gets the font size of a style. More...
LO_RESULT | LOStyleSetFontSize (LOStyleRef style, double size_in_points)
| Sets the font size of a style. On Windows only, this font size will be truncated to an integer value. More...
LO_RESULT | LOStyleGetTextColor (LOStyleRef style, SUColor *color)
| Gets the text color of a style. More...
LO_RESULT | LOStyleSetTextColor (LOStyleRef style, SUColor color)
| Sets the text color of a style. More...
LO_RESULT | LOStyleGetTextUnderline (LOStyleRef style, LOTextUnderline *underline_type)
| Gets the text underline type of a style. More...
LO_RESULT | LOStyleSetTextUnderline (LOStyleRef style, LOTextUnderline underline_type)
| Sets the text underline type of a style. More...
LO_RESULT | LOStyleGetTextStrikeThrough (LOStyleRef style, LOTextStrikeThrough *strikethrough_type)
| Gets the text strike through type for a style. More...
LO_RESULT | LOStyleSetTextStrikeThrough (LOStyleRef style, LOTextStrikeThrough strikethrough_type)
| Sets the text strike through type of a style. More...
LO_RESULT | LOStyleGetTextElevation (LOStyleRef style, LOTextElevation *elevation_type)
| Gets the text elevation type (normal, superscript, or subscript) of a style. More...
LO_RESULT | LOStyleSetTextElevation (LOStyleRef style, LOTextElevation elevation_type)
| Sets the text elevation type of a style. More...
LO_RESULT | LOStyleGetTextAlignment (LOStyleRef style, LOTextAlignment *alignment_type)
| Gets the text alignment type of a style. More...
LO_RESULT | LOStyleSetTextAlignment (LOStyleRef style, LOTextAlignment alignment_type)
| Sets the text alignment type of a style. More...
LO_RESULT | LOStyleGetTextAnchor (LOStyleRef style, LOTextAnchor *anchor_type)
| Gets the text alignment type of a style. More...
LO_RESULT | LOStyleSetTextAnchor (LOStyleRef style, LOTextAnchor anchor_type)
| Sets the text alignment type of a style. More...
LO_RESULT | LOStyleGetDimensionRotationAlignment (LOStyleRef style, LODimensionRotationAlignment *alignment)
| Gets the dimension rotation alignment type of a style. More...
LO_RESULT | LOStyleSetDimensionRotationAlignment (LOStyleRef style, LODimensionRotationAlignment alignment)
| Sets the dimension rotation alignment type of a style. More...
LO_RESULT | LOStyleGetDimensionVerticalAlignment (LOStyleRef style, LODimensionVerticalAlignment *alignment)
| Gets the dimension vertical alignment setting of a style. More...
LO_RESULT | LOStyleSetDimensionVerticalAlignment (LOStyleRef style, LODimensionVerticalAlignment alignment)
| Sets the dimension vertical alignment setting of a style. You can not set the alignment to LODimensionVerticalAlignment_Offset because it requires a relative vector for the position. More...
LO_RESULT | LOStyleGetDimensionUnits (LOStyleRef style, LODimensionUnits *units, double *precision)
| Gets the dimension units and precision of a style. More...
LO_RESULT | LOStyleSetDimensionUnits (LOStyleRef style, LODimensionUnits units, double precision)
| Sets the dimension units and precision of a style. More...
LO_RESULT | LOStyleGetSuppressDimensionUnits (LOStyleRef style, bool *is_suppressed)
| Gets the dimension shall sppress unit display attribute of a style. More...
LO_RESULT | LOStyleSetSuppressDimensionUnits (LOStyleRef style, bool is_suppressed)
| Sets the dimension shall sppress unit display attribute of a style. More...
LO_RESULT | LOStrokePatternGetMaximumNumberOfWidths (size_t *num_widths)
| Gets the maximum number of widths that may be returned by LOStrokePatternGetWidths. Use this to determine the size of the array to pass to LOStrokePatternGetWidths. More...
LO_RESULT | LOStrokePatternGetWidths (LOStrokePattern stroke_pattern, size_t len, double widths[], size_t *num_widths)
| Gets the widths of the alternating dashes and gaps for the given stroke pattern. These widths are expressed in paper space inches, and may be scaled (see LOStyleGetStrokePatternScale). Use LOStrokePatternGetMaximumNumberOfWidths to determine an adequate length for the widths array. More...
LO_RESULT | LOStyleGetStartArrowType (LOStyleRef style, LOArrowType *type)
| Gets the the start arrow type of a style. More...
LO_RESULT | LOStyleSetStartArrowType (LOStyleRef style, LOArrowType type)
| Sets the the start arrow type of a style. More...
LO_RESULT | LOStyleGetStartArrowSize (LOStyleRef style, double *size)
| Gets the the start arrow size of a style. More...
LO_RESULT | LOStyleSetStartArrowSize (LOStyleRef style, double size)
| Sets the the start arrow size of a style. More...
LO_RESULT | LOStyleGetEndArrowType (LOStyleRef style, LOArrowType *type)
| Gets the end arrow type of a style. More...
LO_RESULT | LOStyleSetEndArrowType (LOStyleRef style, LOArrowType type)
| Sets the end arrow type of a style. More...
LO_RESULT | LOStyleGetEndArrowSize (LOStyleRef style, double *size)
| Gets the end arrow size of a style. More...
LO_RESULT | LOStyleSetEndArrowSize (LOStyleRef style, double size)
| Sets the end arrow size of a style. More...
LO_RESULT | LOStyleIsArrowTypeFilled (LOArrowType type, bool *filled)
| Gets whether or not an arrow type is filled in. More...
LO_RESULT | LOStyleSetSubEntityStyle (LOStyleRef style, LOSubEntityType type, LOStyleRef sub_style)
| Adds a style to apply to an entity's sub-entity. This would be used to set the arrow head type for extension lines of a dimension, for example. More...
LO_RESULT | LOStyleGetSubEntityStyle (LOStyleRef style, LOSubEntityType type, LOStyleRef *sub_style)
| Gets the style settings for a sub entity from a style. This would be used to get the current style of a dimension's text, for example. More...

## Enumeration Type Documentation

enum LOArrowType

Defines the arrowhead types available for a path entity.

Enumerator
LOArrowType_None | No arrowhead.
LOArrowType_FilledTriangle | Filled triangle arrowhead.
LOArrowType_OpenTriangle | Non-filled triangle arrowhead.
LOArrowType_FilledSkinnyTriangle | Filled skinny triangle arrowhead.
LOArrowType_OpenSkinnyTriangle | Non-filled skinny triangle arrowhead.
LOArrowType_OpenArrow90 | 90 degree open-sided arrowhead.
LOArrowType_OpenArrow120 | 120 degree open-sided arrowhead.
LOArrowType_FilledCircle | Filled circle arrowhead.
LOArrowType_OpenCircle | Non-filled circle arrowhead.
LOArrowType_FilledSquare | Filled square arrowhead.
LOArrowType_OpenSquare | Non-filled square arrowhead.
LOArrowType_FilledDiamond | Filled diamond arrowhead.
LOArrowType_OpenDiamond | Non-filled diamond arrowhead.
LOArrowType_Star | Star-shaped arrowhead.
LOArrowType_T | T-shaped arrowhead.
LOArrowType_SlashRight | Right slash arrowhead.
LOArrowType_SlashLeft | Left slash arrowhead.
LOArrowType_Underrun | Underrun arrowhead.
LOArrowType_Overrun | Overrun arrowhead.
LONumArrowTypes |

enum LODimensionRotationAlignment

Represents how the dimension text is oriented on the page.

Enumerator
LODimensionRotationAlignment_Horizontal | Align the text horizontally.
LODimensionRotationAlignment_Vertical | Align the text vertically.
LODimensionRotationAlignment_Align | Align the text parallel to the dimension line.
LODimensionRotationAlignment_Perpendicular | Align the text perpendicular to the dimension line.
LONumDimensionRotationAlignments |

enum LODimensionUnits

Defines the different units formats that are available for linear and angular dimensions.

Enumerator
LODimensionUnits_FractionalInches | 60"
LODimensionUnits_ArchitecturalInches | 6-1/2"
LODimensionUnits_EngineeringFeet | 7.250'
LODimensionUnits_DecimalInches | 6.5"
LODimensionUnits_DecimalFeet | 0.54167'
LODimensionUnits_DecimalMillimeters | 165.1 mm
LODimensionUnits_DecimalCentimeters | 16.51 cm
LODimensionUnits_DecimalMeters | 1.651 m
LODimensionUnits_DecimalPoints | 468 pt
LODimensionUnits_Degrees | 21°
LODimensionUnits_Radians | 0.36 r
LONumDimensionUnits |

enum LODimensionVerticalAlignment

Represents how the dimension text is positioned. The position is relative to the dimension line. LODimensionVerticalAlignment_Offset indicates that the text box position is based on a custom offset.

Enumerator
LODimensionVerticalAlignment_Above | Position the text above the dimension line.
LODimensionVerticalAlignment_Center | Position the text on top of the dimension line.
LODimensionVerticalAlignment_Below | Position the text under the dimension line.
LODimensionVerticalAlignment_Offset | Position the text in an arbitrary location.
LONumDimensionVerticalAlignments |

enum LOStrokeCapStyle

Defines how to draw the end-caps of a path's stroke.

Enumerator
LOStrokeCapStyle_Flat | The end caps will be flat.
LOStrokeCapStyle_Round | The end caps will be round.
LOStrokeCapStyle_Square | The end caps will be square.
LONumStrokeCapStyles |

enum LOStrokeJoinStyle

Defines how to draw the connection between two segments of a path's stroke.

Enumerator
LOStrokeJoinStyle_Miter | The corner between two segments will be pointed.
LOStrokeJoinStyle_Round | The corner between two segments will be rounded.
LOStrokeJoinStyle_Bevel | The corner between two segments will be flat.
LONumStrokeJoinStyles |

enum LOStrokePattern

Defines the stippling pattern of a path's stroke.

Enumerator
LOStrokePattern_Solid | Solid pattern.
LOStrokePattern_Dash | Dashed pattern.
LOStrokePattern_Dot | Dotted pattern.
LOStrokePattern_DashDot | Repeating dash-dot pattern.
LOStrokePattern_DashDotDot | Repeating dash-dot-dot pattern.
LOStrokePattern_DashSpace | Deprecated in 2020.2. Use LOStrokePattern_Dash instead.
LOStrokePattern_DashDotDotDot | Repeating dash-dot-dot-dot pattern.
LOStrokePattern_DashDashDot | Repeating dash-dash-dot pattern.
LOStrokePattern_DashDashDotDot | Repeating dash-dash-dot-dot pattern.
LOStrokePattern_DashDashDotDotDot | Repeating dash-dash-dot-dot-dot pattern.
LOStrokePattern_Center | Repeating center line type pattern.
LOStrokePattern_Phantom | Repeating phantom line type pattern.
LOStrokePattern_ShortDash | Repeating short dash pattern.
LONumStrokePatterns |

enum LOSubEntityType

Defines the types of sub entity that may have style attributes applied directly to them.

Enumerator
LOSubEntityType_LabelLeaderLine | A label's leader line object.
LOSubEntityType_LabelText | A label's text object.
LOSubEntityType_DimensionStartExtensionLine | A dimension's start extension line object.
LOSubEntityType_DimensionEndExtensionLine | A dimension's end extension line object.
LOSubEntityType_DimensionDimensionLine | A dimension's dimension line object.
LOSubEntityType_DimensionLeaderLine | A dimension's leader line object.
LOSubEntityType_DimensionText | A dimension's text object.
LONumSubEntityTypes |

enum LOTextAlignment

Defines left/right/center text alignment for formatted text.

Enumerator
LOTextAlignment_Left | Left-aligned text.
LOTextAlignment_Right | Right-aligned text.
LOTextAlignment_Center | Center-aligned text.
LONumTextAlignments |

enum LOTextAnchor

Defines top/center/bottom text anchoring for formatted text.

Enumerator
LOTextAnchor_Top | Top-anchored text.
LOTextAnchor_Center | Center-anchored text.
LOTextAnchor_Bottom | Bottom-anchored text.
LONumTextAnchors |

enum LOTextElevation

Defines super/subscript options for formatted text.

Enumerator
LOTextElevation_Normal | Normal text.
LOTextElevation_Superscript | Superscript text.
LOTextElevation_Subscript | Subscript text.
LONumTextElevations |

enum LOTextStrikeThrough

Defines strike through styles for formatted text.

Since
  LayOut 2026.0, API 11.0

Enumerator
LOTextStrikeThrough_None | No strike through.
LOTextStrikeThrough_Single | Single strike through.
LONumTextStrikeThroughs |

enum LOTextUnderline

Defines underline styles for formatted text.

Enumerator
LOTextUnderline_None | No underline.
LOTextUnderline_Single | Single underline.
LOTextUnderline_Double | Double underline.
LONumTextUnderlines |

## Function Documentation

LO_RESULT LOStrokePatternGetMaximumNumberOfWidths | ( | size_t * | num_widths | ) |

Gets the maximum number of widths that may be returned by LOStrokePatternGetWidths. Use this to determine the size of the array to pass to LOStrokePatternGetWidths.

Parameters

  [out] | num_widths | The maximum number of widths.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_NULL_POINTER_OUTPUT if num_widths is NULL

LO_RESULT LOStrokePatternGetWidths | ( | LOStrokePattern | stroke_pattern,
|  | size_t | len,
|  | double | widths[],
|  | size_t * | num_widths
| ) |  |

Gets the widths of the alternating dashes and gaps for the given stroke pattern. These widths are expressed in paper space inches, and may be scaled (see LOStyleGetStrokePatternScale). Use LOStrokePatternGetMaximumNumberOfWidths to determine an adequate length for the widths array.

Parameters

  [in] | stroke_pattern | The stroke pattern.
  [in] | len | The maximum number of widths to return.
  [out] | widths | The widths for the stroke pattern.
  [out] | num_widths | The number of widths returned.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_OUT_OF_RANGE if stroke_pattern is invalid
  - SU_ERROR_NULL_POINTER_OUTPUT if widths is NULL
  - SU_ERROR_NULL_POINTER_OUTPUT if num_widths is NULL

LO_RESULT LOStyleCopy | ( | LOStyleRef | src_style,
|  | LOStyleRef | dst_style
| ) |  |

Copies the style attributes from one style object to another.

Parameters

  [in] | src_style | The source style object.
  [out] | dst_style | The destination style object.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if src_style does not refer to a valid object
  - SU_ERROR_INVALID_OUTPUT if dst_style does not refer to a valid object

LO_RESULT LOStyleCreate | ( | LOStyleRef * | style | ) |

Creates a new empty style object.

Parameters

  [out] | style | The style object.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_NULL_POINTER_OUTPUT if style is NULL
  - SU_ERROR_OVERWRITE_VALID if *style already refers to a valid object

LO_RESULT LOStyleGetDimensionRotationAlignment | ( | LOStyleRef | style,
|  | LODimensionRotationAlignment * | alignment
| ) |  |

Gets the dimension rotation alignment type of a style.

Parameters

  [in] | style | The style object.
  [out] | alignment | The alignment.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if alignment is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetDimensionUnits | ( | LOStyleRef | style,
|  | LODimensionUnits * | units,
|  | double * | precision
| ) |  |

Gets the dimension units and precision of a style.

Parameters

  [in] | style | The style object.
  [out] | units | The units setting.
  [out] | precision | The units precision. This is expressed as a value in the current units.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if units is NULL
  - SU_ERROR_NULL_POINTER_OUTPUT if precision is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetDimensionVerticalAlignment | ( | LOStyleRef | style,
|  | LODimensionVerticalAlignment * | alignment
| ) |  |

Gets the dimension vertical alignment setting of a style.

Parameters

  [in] | style | The style object.
  [out] | alignment | The alignment.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if alignment is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetEndArrowSize | ( | LOStyleRef | style,
|  | double * | size
| ) |  |

Gets the end arrow size of a style.

Parameters

  [in] | style | The style object.
  [out] | size | The arrow size.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if size is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style

LO_RESULT LOStyleGetEndArrowType | ( | LOStyleRef | style,
|  | LOArrowType * | type
| ) |  |

Gets the end arrow type of a style.

Parameters

  [in] | style | The style object.
  [out] | type | The arrow type.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if type is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style

LO_RESULT LOStyleGetFontSize | ( | LOStyleRef | style,
|  | double * | size_in_points
| ) |  |

Gets the font size of a style.

Parameters

  [in] | style | The style object.
  [out] | size_in_points | The font size in points.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if size_in_points is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetPatternFilled | ( | LOStyleRef | style,
|  | bool * | pattern_filled
| ) |  |

Gets whether there is a pattern fill or not of a style.

Parameters

  [in] | style | The style object.
  [out] | pattern_filled | Whether there is a pattern fill or not.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if pattern_filled is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetPatternFillImagePath | ( | LOStyleRef | style,
|  | SUStringRef * | image_path
| ) |  |

Gets the pattern fill image path of a style. This is the file path for the pattern fill image file reference.

Parameters

  [in] | style | The style object.
  [out] | image_path | The pattern fill image path.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if image_path is NULL
  - SU_ERROR_INVALID_OUTPUT if *image_path does not refer to a valid string object
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetPatternFillOrigin | ( | LOStyleRef | style,
|  | LOPoint2D * | origin
| ) |  |

Gets the origin for the pattern fill of a style.

Parameters

  [in] | style | The style object.
  [out] | origin | The paper space origin for the pattern fill.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if origin is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetPatternFillRotation | ( | LOStyleRef | style,
|  | double * | rotation
| ) |  |

Gets the rotation angle applied to the pattern fill of a style.

Parameters

  [in] | style | The style object.
  [out] | rotation | The rotation angle applied to the pattern fill, in degrees.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if rotation is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetPatternFillScale | ( | LOStyleRef | style,
|  | double * | scale
| ) |  |

Gets the scale applied to the pattern fill of a style.

Parameters

  [in] | style | The style object.
  [out] | scale | The scale applied to the pattern fill.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if scale is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetSolidFillColor | ( | LOStyleRef | style,
|  | SUColor * | fill_color
| ) |  |

Gets the solid fill color of a style.

Parameters

  [in] | style | The style object.
  [out] | fill_color | The solid fill color.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if fill_color is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetSolidFilled | ( | LOStyleRef | style,
|  | bool * | solid_filled
| ) |  |

Gets whether or not a style has a solid color fill.

Parameters

  [in] | style | The style object.
  [out] | solid_filled | Whether there is a solid color fill or not.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if solid_filled is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetStartArrowSize | ( | LOStyleRef | style,
|  | double * | size
| ) |  |

Gets the the start arrow size of a style.

Parameters

  [in] | style | The style object.
  [out] | size | The arrow size.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if size is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style

LO_RESULT LOStyleGetStartArrowType | ( | LOStyleRef | style,
|  | LOArrowType * | type
| ) |  |

Gets the the start arrow type of a style.

Parameters

  [in] | style | The style object.
  [out] | type | The arrow type.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if type is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style

LO_RESULT LOStyleGetStrokeCapStyle | ( | LOStyleRef | style,
|  | LOStrokeCapStyle * | cap_type
| ) |  |

Gets the stroke cap style of a style.

Parameters

  [in] | style | The style object.
  [out] | cap_type | The cap style.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if cap_type is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetStrokeColor | ( | LOStyleRef | style,
|  | SUColor * | stroke_color
| ) |  |

Gets the stroke color of a style.

Parameters

  [in] | style | The style object.
  [out] | stroke_color | The stroke color.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if stroke_color is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetStroked | ( | LOStyleRef | style,
|  | bool * | is_stroked
| ) |  |

Gets whether or not a style has a stroke.

Parameters

  [in] | style | The style object.
  [out] | is_stroked | Whether there is a stroke or not.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if is_stroked is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetStrokeJoinStyle | ( | LOStyleRef | style,
|  | LOStrokeJoinStyle * | join_type
| ) |  |

Gets the stroke join style of a style.

Parameters

  [in] | style | The style object.
  [out] | join_type | The join style.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if join_type is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetStrokePattern | ( | LOStyleRef | style,
|  | LOStrokePattern * | stroke_pattern
| ) |  |

Gets the stroke pattern of a style.

Parameters

  [in] | style | The style object.
  [out] | stroke_pattern | The stroke pattern.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if stroke_pattern is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetStrokePatternScale | ( | LOStyleRef | style,
|  | double * | pattern_scale
| ) |  |

Gets the stroke pattern scale of a style.

Parameters

  [in] | style | The style object.
  [out] | pattern_scale | The stroke pattern scale.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if pattern_scale is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetStrokeWidth | ( | LOStyleRef | style,
|  | double * | stroke_width
| ) |  |

Gets the stroke width of a style.

Parameters

  [in] | style | The style object.
  [out] | stroke_width | The stroke width.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if stroke_width is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetSubEntityStyle | ( | LOStyleRef | style,
|  | LOSubEntityType | type,
|  | LOStyleRef * | sub_style
| ) |  |

Gets the style settings for a sub entity from a style. This would be used to get the current style of a dimension's text, for example.

Parameters

  [in] | style | The style containing the sub entity style.
  [in] | type | The type of sub entity the sub style is for.
  [in] | sub_style | The sub entity style.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if sub_style is NULL
  - SU_ERROR_INVALID_OUTPUT if sub_style does not refer to a valid object
  - SU_ERROR_OUT_OF_RANGE if type is invalid

LO_RESULT LOStyleGetSuppressDimensionUnits | ( | LOStyleRef | style,
|  | bool * | is_suppressed
| ) |  |

Gets the dimension shall sppress unit display attribute of a style.

Parameters

  [in] | style | The style object.
  [out] | is_suppressed | Is the dimension suppressing unit display.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if is_suppressed is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetTextAlignment | ( | LOStyleRef | style,
|  | LOTextAlignment * | alignment_type
| ) |  |

Gets the text alignment type of a style.

Parameters

  [in] | style | The style object.
  [out] | alignment_type | The alignment type for text.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if alignment_type is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetTextAnchor | ( | LOStyleRef | style,
|  | LOTextAnchor * | anchor_type
| ) |  |

Gets the text alignment type of a style.

Parameters

  [in] | style | The style object.
  [out] | anchor_type | The anchor type for text.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if anchor_type is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetTextBold | ( | LOStyleRef | style,
|  | bool * | is_bold
| ) |  |

Gets whether or not text should be bold for a style.

Parameters

  [in] | style | The style object.
  [out] | is_bold | Whether text will be bolded or not.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if is_bold is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetTextColor | ( | LOStyleRef | style,
|  | SUColor * | color
| ) |  |

Gets the text color of a style.

Parameters

  [in] | style | The style object.
  [out] | color | The color of the text.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if color is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetTextElevation | ( | LOStyleRef | style,
|  | LOTextElevation * | elevation_type
| ) |  |

Gets the text elevation type (normal, superscript, or subscript) of a style.

Parameters

  [in] | style | The style object.
  [out] | elevation_type | The text elevation type.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if elevation_type is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetTextFontFamily | ( | LOStyleRef | style,
|  | SUStringRef * | family
| ) |  |

Gets the text font name of a style.

Parameters

  [in] | style | The style object.
  [out] | family | The name of the font.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if family is NULL
  - SU_ERROR_INVALID_OUTPUT if family does not refer to a valid object
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetTextItalic | ( | LOStyleRef | style,
|  | bool * | is_italic
| ) |  |

Gets whether or not text should be italicized for a style.

Parameters

  [in] | style | The style object.
  [out] | is_italic | Whether text will be italic or not.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if is_italic is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleGetTextStrikeThrough | ( | LOStyleRef | style,
|  | LOTextStrikeThrough * | strikethrough_type
| ) |  |

Gets the text strike through type for a style.

Since
  LayOut 2026.0, API 11.0

Parameters

  [in] | style | The style object.
  [out] | strikethrough_type | The type of strike through for text.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if `style` does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if `strikethrough_type` is NULL
  - SU_ERROR_NO_DATA if `style` doesn't specify a value for this style attribute

LO_RESULT LOStyleGetTextUnderline | ( | LOStyleRef | style,
|  | LOTextUnderline * | underline_type
| ) |  |

Gets the text underline type of a style.

Parameters

  [in] | style | The style object.
  [out] | underline_type | The type of underline for text.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_OUTPUT if underline_type is NULL
  - SU_ERROR_NO_DATA if style doesn't specify a value for this style attribute

LO_RESULT LOStyleIsArrowTypeFilled | ( | LOArrowType | type,
|  | bool * | filled
| ) |  |

Gets whether or not an arrow type is filled in.

Parameters

  [in] | type | The arrow type.
  [out] | filled | Whether the arrow type is filled in or not.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_NULL_POINTER_OUTPUT if filled is NULL
  - SU_ERROR_OUT_OF_RANGE if type is invalid

LO_RESULT LOStyleRelease | ( | LOStyleRef * | style | ) |

Releases a style object. *style will be set to invalid by this function.

Parameters

  [in] | style | The style object.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_NULL_POINTER_INPUT if style is NULL
  - SU_ERROR_INVALID_INPUT if *style does not refer to a valid object

LO_RESULT LOStyleSetDimensionRotationAlignment | ( | LOStyleRef | style,
|  | LODimensionRotationAlignment | alignment
| ) |  |

Sets the dimension rotation alignment type of a style.

Parameters

  [in] | style | The style object.
  [in] | alignment | The new alignment to use.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_OUT_OF_RANGE if alignment is not a valid value

LO_RESULT LOStyleSetDimensionUnits | ( | LOStyleRef | style,
|  | LODimensionUnits | units,
|  | double | precision
| ) |  |

Sets the dimension units and precision of a style.

Parameters

  [in] | style | The style object.
  [out] | units | The units setting for the document.
  [out] | precision | The units precision. This is expressed as a value in the specified units. LayOut only allows for a finite set of precision values for each units setting, so it will set the precision to the closest valid setting for the specified units. See the "Dimension Inspector" for a reference of the available precisions for each units setting.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_OUT_OF_RANGE if units is invalid

LO_RESULT LOStyleSetDimensionVerticalAlignment | ( | LOStyleRef | style,
|  | LODimensionVerticalAlignment | alignment
| ) |  |

Sets the dimension vertical alignment setting of a style. You can not set the alignment to LODimensionVerticalAlignment_Offset because it requires a relative vector for the position.

Parameters

  [in] | style | The style object.
  [in] | alignment | The new alignment to use.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_OUT_OF_RANGE if alignment is not a valid value

LO_RESULT LOStyleSetEndArrowSize | ( | LOStyleRef | style,
|  | double | size
| ) |  |

Sets the end arrow size of a style.

Parameters

  [in] | style | The style object.
  [in] | size | The arrow size.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_OUT_OF_RANGE if size is less than 0.25

LO_RESULT LOStyleSetEndArrowType | ( | LOStyleRef | style,
|  | LOArrowType | type
| ) |  |

Sets the end arrow type of a style.

Parameters

  [in] | style | The style object.
  [in] | type | The arrow type.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_OUT_OF_RANGE if type is invalid

LO_RESULT LOStyleSetFontSize | ( | LOStyleRef | style,
|  | double | size_in_points
| ) |  |

Sets the font size of a style. On Windows only, this font size will be truncated to an integer value.

Parameters

  [in] | style | The style object.
  [in] | size_in_points | The font size in points.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_OUT_OF_RANGE if size_in_points is less than 1.0

LO_RESULT LOStyleSetPatternFilled | ( | LOStyleRef | style,
|  | bool | pattern_filled
| ) |  |

Sets whether or not a style has a pattern fill.

Parameters

  [in] | style | The style object.
  [in] | pattern_filled | Whether there should be a pattern fill or not.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object

LO_RESULT LOStyleSetPatternFillImagePath | ( | LOStyleRef | style,
|  | const char * | image_path
| ) |  |

Sets the pattern fill image path of a style. This is the file path for the pattern fill image file reference.

Parameters

  [in] | style | The style object.
  [in] | image_path | The pattern fill image path.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_INPUT if image_path is NULL
  - SU_ERROR_SERIALIZATION if the image file could not be loaded

LO_RESULT LOStyleSetPatternFillOrigin | ( | LOStyleRef | style,
|  | const LOPoint2D * | origin
| ) |  |

Sets the origin for the pattern fill of a style.

Parameters

  [in] | style | The style object.
  [out] | origin | The paper space origin for the pattern fill.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_INPUT if origin is NULL

LO_RESULT LOStyleSetPatternFillRotation | ( | LOStyleRef | style,
|  | double | rotation
| ) |  |

Sets the rotation angle applied to the pattern fill of a style.

Parameters

  [in] | style | The style object.
  [out] | rotation | The rotation angle to apply to the pattern fill, in degrees.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object attribute

LO_RESULT LOStyleSetPatternFillScale | ( | LOStyleRef | style,
|  | double | scale
| ) |  |

Sets the scale applied to the pattern fill of a style.

Parameters

  [in] | style | The style object.
  [out] | scale | The scale to apply to the pattern fill.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object attribute
  - SU_ERROR_OUT_OF_RANGE if scale is less than 0.001 or greater than 9999.0

LO_RESULT LOStyleSetSolidFillColor | ( | LOStyleRef | style,
|  | SUColor | fill_color
| ) |  |

Sets the solid fill color of a style.

Parameters

  [in] | style | The style object.
  [in] | fill_color | The solid fill color.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object

LO_RESULT LOStyleSetSolidFilled | ( | LOStyleRef | style,
|  | bool | solid_filled
| ) |  |

Sets whether or not a style has a solid color fill.

Parameters

  [in] | style | The style object.
  [in] | solid_filled | Whether there should be a solid color fill or not.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object

LO_RESULT LOStyleSetStartArrowSize | ( | LOStyleRef | style,
|  | double | size
| ) |  |

Sets the the start arrow size of a style.

Parameters

  [in] | style | The style object.
  [in] | size | The arrow size.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_OUT_OF_RANGE if size is less than 0.25

LO_RESULT LOStyleSetStartArrowType | ( | LOStyleRef | style,
|  | LOArrowType | type
| ) |  |

Sets the the start arrow type of a style.

Parameters

  [in] | style | The style object.
  [in] | type | The arrow type.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_OUT_OF_RANGE if type is invalid

LO_RESULT LOStyleSetStrokeCapStyle | ( | LOStyleRef | style,
|  | LOStrokeCapStyle | cap_type
| ) |  |

Sets the stroke cap style of a style.

Parameters

  [in] | style | The style object.
  [in] | cap_type | The cap style.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_OUT_OF_RANGE if cap_type is invalid

LO_RESULT LOStyleSetStrokeColor | ( | LOStyleRef | style,
|  | SUColor | stroke_color
| ) |  |

Sets the stroke color of a style.

Parameters

  [in] | style | The style object.
  [in] | stroke_color | The stroke color.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object

LO_RESULT LOStyleSetStroked | ( | LOStyleRef | style,
|  | bool | is_stroked
| ) |  |

Sets whether or not a style has a stroke.

Parameters

  [in] | style | The style object.
  [in] | is_stroked | Whether there should be a stroke or not.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object

LO_RESULT LOStyleSetStrokeJoinStyle | ( | LOStyleRef | style,
|  | LOStrokeJoinStyle | join_type
| ) |  |

Sets the stroke join style of a style.

Parameters

  [in] | style | The style object.
  [in] | join_type | The join style.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_OUT_OF_RANGE if join_type is invalid

LO_RESULT LOStyleSetStrokePattern | ( | LOStyleRef | style,
|  | LOStrokePattern | stroke_pattern
| ) |  |

Sets the stroke pattern of a style.

Parameters

  [in] | style | The style object.
  [in] | stroke_pattern | The stroke pattern.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_OUT_OF_RANGE if stroke_pattern is invalid

LO_RESULT LOStyleSetStrokePatternScale | ( | LOStyleRef | style,
|  | double | pattern_scale
| ) |  |

Sets the stroke pattern scale of a style.

Parameters

  [in] | style | The style object.
  [in] | pattern_scale | The stroke pattern scale.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_OUT_OF_RANGE if pattern_scale is less than 0.001 or greater than 9999.0

LO_RESULT LOStyleSetStrokeWidth | ( | LOStyleRef | style,
|  | double | stroke_width
| ) |  |

Sets the stroke width of a style.

Parameters

  [in] | style | The style object.
  [in] | stroke_width | The stroke width.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_OUT_OF_RANGE if stroke_width is less than 0.0

LO_RESULT LOStyleSetSubEntityStyle | ( | LOStyleRef | style,
|  | LOSubEntityType | type,
|  | LOStyleRef | sub_style
| ) |  |

Adds a style to apply to an entity's sub-entity. This would be used to set the arrow head type for extension lines of a dimension, for example.

Parameters

  [in] | style | The style to contain the sub entity style.
  [in] | type | The type of sub entity the sub style is for.
  [in] | sub_style | The style to set as a sub entity style.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_INVALID_INPUT if sub_style does not refer to a valid object
  - SU_ERROR_OUT_OF_RANGE if type is invalid

LO_RESULT LOStyleSetSuppressDimensionUnits | ( | LOStyleRef | style,
|  | bool | is_suppressed
| ) |  |

Sets the dimension shall sppress unit display attribute of a style.

Parameters

  [in] | style | The style object.
  [in] | is_suppressed | Is the dimension suppressing unit display.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object

LO_RESULT LOStyleSetTextAlignment | ( | LOStyleRef | style,
|  | LOTextAlignment | alignment_type
| ) |  |

Sets the text alignment type of a style.

Parameters

  [in] | style | The style object.
  [in] | alignment_type | The new text alignment type to use.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_OUT_OF_RANGE if alignment_type is invalid

LO_RESULT LOStyleSetTextAnchor | ( | LOStyleRef | style,
|  | LOTextAnchor | anchor_type
| ) |  |

Sets the text alignment type of a style.

Parameters

  [in] | style | The style object.
  [in] | anchor_type | The new text anchor type to use.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_OUT_OF_RANGE if anchor_type is invalid

LO_RESULT LOStyleSetTextBold | ( | LOStyleRef | style,
|  | bool | is_bold
| ) |  |

Sets whether or not text should be bold for a style.

Parameters

  [in] | style | The style object.
  [out] | is_bold | Whether text should be bolded or not.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object

LO_RESULT LOStyleSetTextColor | ( | LOStyleRef | style,
|  | SUColor | color
| ) |  |

Sets the text color of a style.

Parameters

  [in] | style | The style object.
  [in] | color | The new text color to use.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object

LO_RESULT LOStyleSetTextElevation | ( | LOStyleRef | style,
|  | LOTextElevation | elevation_type
| ) |  |

Sets the text elevation type of a style.

Parameters

  [in] | style | The style object.
  [in] | elevation_type | The new text elevation type to use.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_OUT_OF_RANGE if elevation_type is invalid

LO_RESULT LOStyleSetTextFontFamily | ( | LOStyleRef | style,
|  | const char * | family
| ) |  |

Sets the text font name of a style.

Parameters

  [in] | style | The style object.
  [in] | family | The name of the new font to use.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_NULL_POINTER_INPUT if family is NULL

LO_RESULT LOStyleSetTextItalic | ( | LOStyleRef | style,
|  | bool | is_italic
| ) |  |

Sets whether or not text should be italicized for a style.

Parameters

  [in] | style | The style object.
  [out] | is_italic | Whether text should be italic or not.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object

LO_RESULT LOStyleSetTextStrikeThrough | ( | LOStyleRef | style,
|  | LOTextStrikeThrough | strikethrough_type
| ) |  |

Sets the text strike through type of a style.

Since
  LayOut 2026.0, API 11.0

Parameters

  [in] | style | The style object.
  [out] | strikethrough_type | The type of strike through to use for text.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if `style` does not refer to a valid object
  - SU_ERROR_OUT_OF_RANGE if `strikethrough_type` is not a valid strike through type

LO_RESULT LOStyleSetTextUnderline | ( | LOStyleRef | style,
|  | LOTextUnderline | underline_type
| ) |  |

Sets the text underline type of a style.

Parameters

  [in] | style | The style object.
  [out] | underline_type | The type of underline to use for text.

Returns
  - SU_ERROR_NONE on success
  - SU_ERROR_INVALID_INPUT if style does not refer to a valid object
  - SU_ERROR_OUT_OF_RANGE if underline_type is invalid