GUIStyleExtensions

Fluent builder-pattern extension methods for UnityEngine.GUIStyle. Every method creates a new GUIStyle copy with the specified property changed, leaving the original unmodified. Enables chaining for concise IMGUI style declarations.

Definition

Namespace: Paragon.Editor Assembly: Editor assembly

public static class GUIStyleExtensions

Quick Lookup

Goal	Method
Set text alignment	style.WithAlignment(TextAnchor.MiddleCenter)
Set border (all sides)	style.WithBorder(2)
Set border (per side)	style.WithBorder(left: 1, top: 2)
Set margin (all sides)	style.WithMargin(4)
Set margin (per side)	style.WithMargin(left: 2, right: 2)
Set padding (all sides)	style.WithPadding(4)
Set padding (per side)	style.WithPadding(left: 8, top: 4)
Set overflow (all sides)	style.WithOverflow(1)
Set overflow (per side)	style.WithOverflow(left: 0, bottom: 2)
Set fixed height	style.WithFixedHeight(24)
Set fixed width	style.WithFixedWidth(100)
Set text clipping	style.WithTextClipping(TextClipping.Overflow)
Set font	style.WithFont(myFont)
Set font size	style.WithFontSize(14)
Set font style	style.WithFontStyle(FontStyle.Bold)
Set background texture	style.WithBackground(texture)
Enable/disable rich text	style.WithRichText(true)
Set stretch height	style.WithStretchHeight(true)
Set stretch width	style.WithStretchWidth(true)
Set word wrap	style.WithWordWrap(true)

Methods

Layout Methods

Each layout method has two overloads: one that sets all sides uniformly, and one with optional per-side values that preserve unspecified sides from the original style.

WithBorder

public static GUIStyle WithBorder(this GUIStyle style, int border)
public static GUIStyle WithBorder(this GUIStyle style, int? left = null, int? right = null, int? top = null, int? bottom = null)

WithMargin

public static GUIStyle WithMargin(this GUIStyle style, int margin)
public static GUIStyle WithMargin(this GUIStyle style, int? left = null, int? right = null, int? top = null, int? bottom = null)

WithPadding

public static GUIStyle WithPadding(this GUIStyle style, int padding = 0)
public static GUIStyle WithPadding(this GUIStyle style, int? left = null, int? right = null, int? top = null, int? bottom = null)

WithOverflow

public static GUIStyle WithOverflow(this GUIStyle style, int overflow)
public static GUIStyle WithOverflow(this GUIStyle style, int? left = null, int? right = null, int? top = null, int? bottom = null)

Size Methods

WithFixedHeight

public static GUIStyle WithFixedHeight(this GUIStyle style, int fixedHeight)

WithFixedWidth

public static GUIStyle WithFixedWidth(this GUIStyle style, int fixedWidth)

Text Methods

WithAlignment

public static GUIStyle WithAlignment(this GUIStyle style, TextAnchor alignment)

WithTextClipping

public static GUIStyle WithTextClipping(this GUIStyle style, TextClipping clipping)

WithFont

public static GUIStyle WithFont(this GUIStyle style, Font font)

WithFontSize

public static GUIStyle WithFontSize(this GUIStyle style, int fontSize)

WithFontStyle

public static GUIStyle WithFontStyle(this GUIStyle style, FontStyle fontStyle)

WithRichText

public static GUIStyle WithRichText(this GUIStyle style, bool richText)

WithWordWrap

public static GUIStyle WithWordWrap(this GUIStyle style, bool wordWrap)

Appearance Methods

WithBackground

Sets the normal.background texture of the style.

public static GUIStyle WithBackground(this GUIStyle style, Texture2D background)

Only sets the normal state background. Other states (hover, active, focused) are not affected. To set backgrounds for other states, modify the returned GUIStyle directly.

WithStretchHeight

public static GUIStyle WithStretchHeight(this GUIStyle style, bool stretchHeight)

WithStretchWidth

public static GUIStyle WithStretchWidth(this GUIStyle style, bool stretchWidth)

Common Pitfalls

Each call creates a new GUIStyle Every With* method allocates a new GUIStyle via new GUIStyle(style). Avoid calling these inside OnGUI() or DrawPropertyLayout() hot paths — cache the result in a field or use lazy initialization.

Per-side overloads preserve originals When using the per-side overloads (e.g., WithPadding(left: 8)), unspecified sides keep the original style's values via null coalescing (left ?? style.padding.left). This is intentional for selective overrides.

Examples

Fluent style chaining

private GUIStyle headerStyle;

private void EnsureStyles()
{
    headerStyle ??= EditorStyles.boldLabel
        .WithFontSize(16)
        .WithAlignment(TextAnchor.MiddleCenter)
        .WithPadding(8)
        .WithFixedHeight(32);
}

Selective per-side padding

// Only override left padding, keep others from base style
GUIStyle indented = EditorStyles.label.WithPadding(left: 20);

See Also

• Editor Extensions README — Overview of all editor extensions