VerticalAlignment

Introduction

VerticalAlignment controls the placement of the letters inside the Text's bounds. To align a TextRuntime in its parent, its YOrigin and YUnits may need to be modified as well to adjust its bounds.

Example - Vertical Alignment Values

The following code shows how to use each VerticalAlignment value:

// Initialize
var topAligned = new TextRuntime();
topAligned.AddToRoot();
topAligned.Text = "Hi, I am some text that is top aligned, even if I line wrap";
topAligned.VerticalAlignment = RenderingLibrary.Graphics.VerticalAlignment.Top;
topAligned.Width = 150;
topAligned.WidthUnits = Gum.DataTypes.DimensionUnitType.Absolute;
topAligned.Height = 150;
topAligned.HeightUnits = Gum.DataTypes.DimensionUnitType.Absolute;
topAligned.X = 50;
topAligned.Y = 100;

var centerAligned = new TextRuntime();
centerAligned.AddToRoot();
centerAligned.Text = "Hi, I am some text that is center aligned, even if I line wrap";
centerAligned.VerticalAlignment = RenderingLibrary.Graphics.VerticalAlignment.Center;
centerAligned.Width = 150;
centerAligned.WidthUnits = Gum.DataTypes.DimensionUnitType.Absolute;
centerAligned.Height = 150;
centerAligned.HeightUnits = Gum.DataTypes.DimensionUnitType.Absolute;
centerAligned.X = 250;
centerAligned.Y = 100;

var bottomAligned = new TextRuntime();
bottomAligned.AddToRoot();
bottomAligned.Text = "Hi, I am some text that is bottom aligned, even if I line wrap";
bottomAligned.VerticalAlignment = RenderingLibrary.Graphics.VerticalAlignment.Bottom;
bottomAligned.Width = 150;
bottomAligned.WidthUnits = Gum.DataTypes.DimensionUnitType.Absolute;
bottomAligned.Height = 150;
bottomAligned.HeightUnits = Gum.DataTypes.DimensionUnitType.Absolute;
bottomAligned.X = 450;
bottomAligned.Y = 100;

Try on XnaFiddle.NET

TODO: Replace with screenshot showing all three VerticalAlignment values.

VerticalAlignment, Anchor, and Dock

The Anchor and Dock methods automatically set VerticalAlignment on Text elements to match the anchor or dock direction. For example, Anchor(Anchor.Bottom) sets VerticalAlignment to Bottom, and Dock(Dock.Left) sets it to Center. This means calling Anchor or Dock overwrites any previously set VerticalAlignment value.

If you need a different alignment than the default, set VerticalAlignment after calling Anchor or Dock to override it. The following example docks a TextRuntime to fill its parent's height (which defaults VerticalAlignment to Center), then overrides it to Top:

// Initialize
var text = new TextRuntime();
text.AddToRoot();
text.Text = "Docked to left, but top-aligned";
// Dock sets VerticalAlignment to Center by default
text.Dock(Gum.Wireframe.Dock.Left);
// Override to top-align the characters within the full-height area
text.VerticalAlignment = RenderingLibrary.Graphics.VerticalAlignment.Top;

The same applies to Anchor. The following example anchors a TextRuntime to the bottom of its parent (which defaults VerticalAlignment to Bottom), then overrides it to Top:

// Initialize
var text = new TextRuntime();
text.AddToRoot();
text.Text = "Bottom-anchored, but top-aligned";
text.Height = 150;
text.HeightUnits = Gum.DataTypes.DimensionUnitType.Absolute;
// Anchor sets VerticalAlignment to Bottom by default
text.Anchor(Gum.Wireframe.Anchor.Bottom);
// Override to top-align the characters inside the element
text.VerticalAlignment = RenderingLibrary.Graphics.VerticalAlignment.Top;