Microsoft Developer Network

Designates the ruby text for the RUBY element.

Members Table

The following table lists the members exposed by the rt object.

Attributes/Properties

Show: Attributes/Properties Behaviors Collections Events Filters Methods Styles

Attribute Property Description ACCESSKEY accessKey Sets or retrieves the accelerator key for the object. ariaBusy   Sets or retrieves the busy state of this element. ariaChecked   Sets or retrieves the checked state of this element. ariaDisabled   Sets or retrieves the disabled state of this element. ariaExpanded   Sets or retrieves the expanded state of this element. ariaHaspopup   Sets or retrieves a value indicating whether this element may display a pop-up window. ariaHidden   Sets or retrieves the hidden state of this element. ariaInvalid   Sets or retrieves the invalid state of this element. ariaLevel   Sets or retrieves the level of this element. ariaMultiselect   Sets or retrieves the multiple-selection state of this element. ariaPosinset   Sets or retrieves the current position of an item within a set. ariaPressed   Sets or retrieves the pressed state of a button that can be toggled. ariaReadonly   Sets or retrieves the read-only state of this element. ariaRequired   Sets or retrieves the form-completion requirement of this element. ariaSecret   Sets or retrieves the secret state of this element. ariaSelected   Sets or retrieves the selection state of this element. ariaSetsize   Sets or retrieves the set size of this element. ATOMICSELECTION Specifies whether the element and its contents must be selected as a whole, indivisible unit. attributes   Retrieves a collection of attributes of the object. canHaveHTML Sets or retrieves the value indicating whether the object can contain rich HTML markup. CLASS className Sets or retrieves the class of the object. CONTENTEDITABLE contentEditable Sets or retrieves the string that indicates whether the user can edit the content of the object. DIR dir Sets or retrieves the reading order of the object. HIDEFOCUS hideFocus Sets or gets the value that indicates whether the object visibly shows that it has focus. ID id Retrieves the string identifying the object. innerHTML Sets or retrieves the HTML between the start and end tags of the object. innerText Sets or retrieves the text between the start and end tags of the object. isContentEditable Gets the value that indicates whether the user can edit the contents of the object. isDisabled Gets the value that indicates whether the user can interact with the object. isMultiLine Retrieves the value indicating whether the content of the object contains one or more lines. LANG lang Sets or retrieves the language to use. LANGUAGE language Sets or retrieves the language in which the current script is written. NAME name Sets or retrieves the name of the object. offsetHeight Retrieves the height of the object relative to the layout or coordinate parent, as specified by the offsetParent property. offsetLeft Retrieves the calculated left position of the object relative to the layout or coordinate parent, as specified by the offsetParent property. offsetParent Retrieves a reference to the container object that defines the offsetTop and offsetLeft properties of the object. offsetTop Retrieves the calculated top position of the object relative to the layout or coordinate parent, as specified by the offsetParent property. offsetWidth Retrieves the width of the object relative to the layout or coordinate parent, as specified by the offsetParent property. outerHTML Sets or retrieves the object and its content in HTML. outerText Sets or retrieves the text of the object. parentElement Retrieves the parent object in the object hierarchy. readyState Retrieves the current state of the object. role   Sets or retrieves the role for this element. scopeName Gets the namespace defined for the element. STYLE Sets an inline style for the element. TABINDEX tabIndex Sets or retrieves the index that defines the tab order for the object. tagName Retrieves the tag name of the object. tagUrn Sets or gets the Uniform Resource Name (URN) specified in the namespace declaration. TITLE title Sets or retrieves advisory information (a ToolTip) for the object. UNSELECTABLE Specifies that an element cannot be selected. Behavior Description clientCaps Provides information about features supported by Internet Explorer, as well as a way for installing browser components on demand. download Downloads a file and notifies a specified callback function when the download is complete. homePage Contains information about a user's homepage. Collection Description behaviorUrns Returns a collection of Uniform Resource Name (URN) strings identifying the behaviors attached to the element. children Retrieves a collection of DHTML Objects that are direct descendants of the object. filters Retrieves the collection of filters that have been applied to the object. Event Description onactivate Fires when the object is set as the active element. onafterupdate Fires on a databound object after successfully updating the associated data in the data source object. onbeforeactivate Fires immediately before the object is set as the active element. onbeforecut Fires on the source object before the selection is deleted from the document. onbeforedeactivate Fires immediately before the activeElement is changed from the current object to another object in the parent document. onbeforeeditfocus Fires before an object contained in an editable element enters a UI-activated state or when an editable container object is control selected. onbeforepaste Fires on the target object before the selection is pasted from the system clipboard to the document. onbeforeupdate Fires on a databound object before updating the associated data in the data source object. onblur Fires when the object loses the input focus. onclick Fires when the user clicks the left mouse button on the object. oncontextmenu Fires when the user clicks the right mouse button in the client area, opening the context menu. oncontrolselect Fires when the user is about to make a control selection of the object. oncut Fires on the source element when the object or selection is removed from the document and added to the system clipboard. ondblclick Fires when the user double-clicks the object. ondeactivate Fires when the activeElement is changed from the current object to another object in the parent document. ondragstart Fires on the source object when the user starts to drag a text selection or selected object. onerrorupdate Fires on a databound object when an error occurs while updating the associated data in the data source object. onfilterchange Fires when a visual filter changes state or completes a transition. onfocus Fires when the object receives focus. onfocusin Fires for an element just prior to setting focus on that element. onfocusout Fires for the current element with focus immediately after moving focus to another element. onhelp Fires when the user presses the F1 key while the browser is the active window. onkeydown Fires when the user presses a key. onkeypress Fires when the user presses an alphanumeric key. onkeyup Fires when the user releases a key. onmousedown Fires when the user clicks the object with either mouse button. onmouseenter Fires when the user moves the mouse pointer into the object. onmouseleave Fires when the user moves the mouse pointer outside the boundaries of the object. onmousemove Fires when the user moves the mouse over the object. onmouseout Fires when the user moves the mouse pointer outside the boundaries of the object. onmouseover Fires when the user moves the mouse pointer into the object. onmouseup Fires when the user releases a mouse button while the mouse is over the object. onmousewheel Fires when the wheel button is rotated. onmove Fires when the object moves. onmoveend Fires when the object stops moving. onmovestart Fires when the object starts to move. onpaste Fires on the target object when the user pastes data, transferring the data from the system clipboard to the document. onreadystatechange Fires when the state of the object has changed. onresizeend Fires when the user finishes changing the dimensions of the object in a control selection. onresizestart Fires when the user begins to change the dimensions of the object in a control selection. onselectstart Fires when the object is being selected. Filter property Description Alpha Adjusts the opacity of the content of the object. AlphaImageLoader Displays an image within the boundaries of the object and between the object background and content, with options to clip or resize the image. When loading a Portable Network Graphics (PNG) image, tranparency—from zero to 100 percent—is supported. Barn Reveals new content of the object with a motion that resembles doors opening or closing. BasicImage Adjusts the color processing, image rotation, or opacity of the content of the object. BlendTrans Reveals new content of the object by fading the original content. Blinds Reveals new content of the object with a motion that appears to open or close blinds. Blur Blurs the content of the object so that it appears out of focus. CheckerBoard Reveals new content of the object by uncovering squares placed like a checkerboard over the original content. Chroma Displays a specific color of the content of the object as transparent. Compositor Displays new content of the object as a logical color combination of the new and original content. The color and alpha values of each version of the content are evaluated to determine the final color on the output image. DropShadow Creates a solid silhouette of the content of the object, offset in the specified direction. This creates the illusion that the content is floating and casting a shadow. Emboss Displays the content of the object as an embossed texture using grayscale values. Engrave Displays the content of the object as an engraved texture using grayscale values. Fade Reveals new content of the object by fading out the original content. FlipH Displays the content of the object flipped across the horizontal axis. FlipV Displays the content of the object flipped across the vertical axis. Glow Adds radiance around the outside edges of the content of the object so that it appears to glow. Gradient Displays a colored surface between the object's background and content. GradientWipe Reveals new content of the object by passing a gradient band over the original content. Gray Displays the content of the object in grayscale. ICMFilter Converts the color content of the object based on an Image Color Management (ICM) profile. This enables improved display of specific content, or simulated display for hardware devices, such as printers or monitors. Inset Reveals new content of the object diagonally. Invert Reverses the hue, saturation, and brightness values of the content of the object. Iris Reveals new content of the object with an iris effect, similar to the opening of a camera aperture. Light Creates the effect of a light shining on the content of the object. MaskFilter Displays transparent pixels of the object content as a color mask, and makes the nontransparent pixels transparent. Matrix Resizes, rotates, or reverses the content of the object using matrix transformation. MotionBlur Causes the content of the object to appear to be in motion. Pixelate Displays the content of the object as colored squares that take the average color value of the pixels they replace. This filtered display can be used as a transition. RadialWipe Reveals new content of the object with a radial wipe, like a windshield-wiper blade. RandomBars Reveals new content of the object by exposing random lines of pixels. RandomDissolve Reveals new content of the object by exposing random pixels. Redirect Not currently supported. RevealTrans Reveals new content of the object using one of 24 predefined Transition effects. Shadow Creates a solid silhouette of the content of the object, offset in the specified direction. This creates the illusion of a shadow. Slide Reveals new content of the object by sliding sections of the image into place. Spiral Reveals new content of the object with a spiral motion. Stretch Reveals new content of the object with a stretching motion to cover the original content. One option resembles a cube rotating from one face to another. Strips Reveals new content of the object by moving successive strips into place, like a diagonal saw blade passing across the original content. Wave Performs a sine wave distortion of the content of the object along the vertical axis. Wheel Reveals new content of the object with a rotating motion, like spokes of a wheel covering the original content. Xray Changes the color depth of the content of the object and displays it in black and white. Zigzag Reveals new content of the object with a forward and back motion that moves down the object. Method Description addBehavior Attaches a behavior to the element. blur Causes the element to lose focus and fires the onblur event. componentFromPoint Returns the component located at the specified coordinates via certain events. fireEvent Fires a specified event on the object. focus Causes the element to receive the focus and executes the code specified by the onfocus event. getAttribute   Retrieves the value of the specified attribute. getAttributeNode Gets an attribute object referenced by the attribute.name property. getExpression Retrieves the expression for the given property. hasAttribute   Determines whether an attribute with the specified name exists. normalize Merges adjacent TextNode objects to produce a normalized document object model. removeAttribute   Removes the given attribute from the object. removeAttributeNode Removes an attribute object from the object. removeBehavior Detaches a behavior from the element. removeExpression Removes the expression from the specified property. setActive Sets the object as active without setting focus to the object. setAttribute   Sets the value of the specified attribute. setAttributeNode Sets an attribute object node as part of the object. setExpression Sets an expression for the specified object. Style attribute Style property Description ACCELERATOR accelerator Sets or retrieves a string that indicates whether the object contains an accelerator key. background-position-x backgroundPositionX Sets or retrieves the x-coordinate of the backgroundPosition property. background-position-y backgroundPositionY Sets or retrieves the y-coordinate of the backgroundPosition property. behavior behavior Sets or retrieves the location of the Dynamic HTML (DHTML) behavior. cursor cursor Sets or retrieves the type of cursor to display as the mouse pointer moves over the object. direction direction Sets or retrieves the reading order of the object. display display Sets or retrieves whether the object is rendered. filter filter Sets or retrieves the filter or collection of filters applied to the object. height height Sets or retrieves the height of the object. layout-grid layoutGrid Sets or retrieves the composite document grid properties that specify the layout of text characters. layout-grid-mode layoutGridMode Sets or retrieves whether the text layout grid uses two dimensions. max-height maxHeight Sets or retrieves the maximum height for an element. max-width maxWidth Sets or retrieves the maximum width for an element. min-height minHeight Sets or retrieves the minimum height for an element. min-width minWidth Sets or retrieves the minimum width for an element. overflow overflow Sets or retrieves a value indicating how to manage the content of the object when the content exceeds the height or width of the object. overflow-x overflowX Sets or retrieves how to manage the content of the object when the content exceeds the width of the object. overflow-y overflowY Sets or retrieves how to manage the content of the object when the content exceeds the height of the object. padding padding Sets or retrieves the amount of space to insert between the object and its margin or, if there is a border, between the object and its border. padding-bottom paddingBottom Sets or retrieves the amount of space to insert between the bottom border of the object and the content. padding-left paddingLeft Sets or retrieves the amount of space to insert between the left border of the object and the content. padding-right paddingRight Sets or retrieves the amount of space to insert between the right border of the object and the content. padding-top paddingTop Sets or retrieves the amount of space to insert between the top border of the object and the content. pixelBottom Sets or retrieves the bottom position of the object. pixelHeight Sets or retrieves the height of the object. pixelLeft Sets or retrieves the left position of the object. pixelRight Sets or retrieves the right position of the object. pixelTop Sets or retrieves the top position of the object. pixelWidth Sets or retrieves the width of the object. posBottom Sets or retrieves the bottom position of the object in the units specified by the bottom attribute. posHeight Sets or retrieves the height of the object in the units specified by the height attribute. posLeft Sets or retrieves the left position of the object in the units specified by the left attribute. posRight Sets or retrieves the right position of the object in the units specified by the right attribute. posTop Sets or retrieves the top position of the object in the units specified by the top attribute. posWidth Sets or retrieves the width of the object in the units specified by the width attribute. float styleFloat Sets or retrieves on which side of the object the text will flow. text-autospace textAutospace Sets or retrieves the autospacing and narrow space width adjustment of text. text-overflow textOverflow Sets or retrieves a value that indicates whether to render ellipses(...) to indicate text overflow. text-underline-position textUnderlinePosition Sets or retrieves the position of the underline decoration that is set through the textDecoration property of the object. unicode-bidi unicodeBidi Sets or retrieves the level of embedding with respect to the bidirectional algorithm. width width Sets or retrieves the width of the object. word-wrap wordWrap Sets or retrieves whether to break words when the content exceeds the boundaries of its container. writing-mode writingMode Sets or retrieves the direction and flow of the content in the object. zoom zoom Sets or retrieves the magnification scale of the object.

Remarks

A ruby is an annotation or pronunciation guide for a string of text. The string of text annotated with a ruby is referred to as the base.

The ruby text specified by the RT element is positioned above or inline with the rubyPosition property. Browsers that do not support the RT element render the ruby text inline with the base text.

This element is available in HTML and script as of Microsoft Internet Explorer 5.

This element is an inline element.

This element does not require a closing tag.

Example

This example uses the RT element to specify a string of text as an annotation or pronunciation guide to the base text.

<RUBY>
   Base Text
   <RT>Ruby Text
</RUBY>

This feature requires Microsoft® Internet Explorer 5 or later. Click the following icon to install the latest version. Then reload this page to view the sample.

Standards Information

This object is part of a proposed addition to HTML .

See Also

ruby