rubyAlign property

Gets or sets a value that indicates how to align the ruby text content.

Syntax

Integer value = object.put_rubyAlign( v);Integer value = object.get_rubyAlign(* sRubyAlign);

Property values

Type: BSTR

one of the values listed in Possible Values.

auto (auto)

Default. Browser determines how the ruby text is aligned. The recommended behavior for an ideographic (Asian character) ruby is to be aligned in the distribute-space mode. The recommended behavior for a Latin character ruby is to be aligned in the center mode.

left (left)

Ruby text is left-aligned with the base.

center (center)

Ruby text is centered within the width of the base. If the length of the base is smaller than the length of the ruby text, the base is centered within the width of the ruby text.

right (right)

Ruby text is right-aligned with the base.

distribute-letter (distribute-letter)

Ruby text is evenly distributed across the width of the base if the width of the ruby text is smaller than the width of the base. If the width of the ruby text is at least the width of the base, the ruby text is center-aligned.

distribute-space (distribute-space)

Ruby text is evenly distributed across the width of the base if the width of the ruby text is smaller than the width of the base. White space precedes the first and follows the last character in the ruby text, equal to half the kerning of the ruby text. If the width of the ruby text is at least the width of the base, the ruby text is centered.

line-edge (line-edge)

Ruby text is centered if it is not adjacent to a line edge. If it is adjacent to a line edge, the side of the ruby text lines up with the side of the base text.

String format

auto | left | center | right | distribute-letter | distribute-space | line-edge

CSS information

Standards information

• CSS3 Ruby Module, Section 4.2

Remarks

The IHTMLStyle2::rubyAlign property specifies the alignment of the ruby text defined by the rt object, and is set on the ruby object.

Requirements

See also

Reference

IHTMLStyle2::rubyPosition

IHTMLStyle2::rubyOverhang