ruby element | ruby object
Designates an annotation or pronunciation guide to be placed above or inline with a string of text.
![]() |
HTML information
| Closing Tag | required |
|---|---|
| CSS Display | inline |
DOM Information
Inheritance Hierarchy
Members
The ruby object has these types of members:
Events
The ruby object has these events.
| Event | Description |
|---|---|
| click |
Fires when the user clicks the left mouse button on the object. Note Starting with IE11, this event fires a MSPointerEvent object instead of MouseEvent. You can use the MouseEvent.pointerType property to determine the type of contact that the click originated from (touch, mouse, or pen).
|
| abort |
Fires when the user aborts the download. |
| activate |
Fires when the object is set as the active element. |
| afterupdate |
Fires on a databound object after successfully updating the associated data in the data source object. |
| beforeactivate |
Fires immediately before the object is set as the active element. |
| beforecopy |
Fires on the source object before the selection is copied to the system clipboard. |
| beforecut |
Fires on the source object before the selection is deleted from the document. |
| beforeeditfocus |
Fires before an object contained in an editable element enters a UI Activation state or when an editable container object is control selection. |
| beforepaste |
Fires on the target object before the selection is pasted from the system clipboard to the document. |
| beforeupdate |
Fires on a databound object before updating the associated data in the data source object. |
| blur |
Fires when the object loses the input focus. |
| cellchange |
Fires when data changes in the data provider. |
| change |
Fires when the contents of the object or selection have changed. |
| contextmenu |
Fires when the user clicks the right mouse button in the client area, opening the context menu. Note Starting with IE11, this event fires a MSPointerEvent object instead of MouseEvent. You can use the MouseEvent.pointerType property to determine the type of contact that the click originated from (touch, mouse, or pen).
|
| controlselect |
Fires when the user is about to make a control selection of the object. |
| cut |
Fires on the source element when the object or selection is removed from the document and added to the system clipboard. |
| dataavailable |
Fires periodically as data arrives from data source objects that asynchronously transmit their data. |
| datasetchanged |
Fires when the data set exposed by a data source object changes. |
| dblclick |
Fires when the user double-clicks the object. Note Starting with IE11, this event fires a MSPointerEvent object instead of a MouseEvent. You can use the MouseEvent.pointerType property to determine the type of contact that the click originated from (touch, mouse, or pen).
|
| deactivate |
Fires when the activeElement is changed from the current object to another object in the parent document. |
| dragstart |
Fires on the source object when the user starts to drag a text selection or selected object. |
| error |
Fires when an error occurs during object loading. |
| errorupdate |
Fires on a databound object when an error occurs while updating the associated data in the data source object. |
| filterchange |
Fires when a visual filter changes state or completes a transition. |
| focus |
Fires when the object receives focus. |
| focusin |
Fires for an element just prior to setting focus on that element. |
| focusout |
Fires for the current element with focus immediately after moving focus to another element. |
| help |
Fires when the user presses the F1 key while the client is the active window. |
| input |
Occurs when the text content of an element is changed through the user interface. |
| keydown |
Fires when the user presses a key. |
| keypress |
Fires when the user presses an alphanumeric key. |
| layoutcomplete |
Fires when the print or print preview layout process finishes filling the current LayoutRect object with content from the source document. |
| load |
Fires immediately after the client loads the object. |
| mousedown |
Fires when the user clicks the object with either mouse button. |
| mouseenter |
Fires when the user moves the mouse pointer into the object. |
| mouseleave |
Fires when the user moves the mouse pointer outside the boundaries of the object. |
| mousemove |
Fires when the user moves the mouse over the object. |
| mouseout |
Fires when the user moves the mouse pointer outside the boundaries of the object. |
| mouseover |
Fires when the user moves the mouse pointer into the object. |
| mouseup |
Fires when the user releases a mouse button while the mouse is over the object. |
| mousewheel |
Fires when the wheel button is rotated. |
| move |
Fires when the object moves. |
| moveend |
Fires when the object stops moving. |
| movestart |
Fires when the object starts to move. |
| onbeforedeactivate |
Fires immediately before the activeElement is changed from the current object to another object in the parent document. |
| ondatasetcomplete |
Fires to indicate that all data is available from the data source object. |
| onkeyup |
Fires when the user releases a key. |
| onselect |
Fires when the current selection changes. |
| paste |
Fires on the target object when the user pastes data, transferring the data from the system clipboard to the document. |
| readystatechange |
Fires when the state of the object has changed. |
| reset |
Fires when the user resets a form. |
| resize |
Fires when the size of the object is about to change. |
| resizeend |
Fires when the user finishes changing the dimensions of the object in a control selection. |
| resizestart |
Fires when the user begins to change the dimensions of the object in a control selection. |
| rowenter |
Fires to indicate that the current row has changed in the data source and new data values are available on the object. |
| rowexit |
Fires just before the data source control changes the current row in the object. |
| rowsdelete |
Fires when rows are about to be deleted from the recordset. |
| rowsinserted |
Fires just after new rows are inserted in the current recordset. |
| scroll |
Fires when the user repositions the scroll box in the scroll bar on the object. |
| selectstart |
Fires when the object is being selected. |
Methods
The ruby object has these methods.
| Method | Description |
|---|---|
| addBehavior |
Attaches a behavior to the element. |
| applyElement |
Makes the element either a child or parent of another element. |
| blur |
Causes the element to lose focus and fires the onblur event. |
| clearAttributes |
Removes all attributes and values from the object. |
| click |
Simulates a click by causing the onclick event to fire. |
| componentFromPoint |
Returns the component located at the specified coordinates via certain events. |
| contains |
Checks whether the given element is contained within the object. |
| doScroll |
Note
doScroll is no longer supported. Starting with IE11, use scrollLeft or scrollTop. For info, see Compatibility changes.
Simulates a click on a scroll bar component. |
| 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. |
| getAttributeNode |
Retrieves an attribute object referenced by the attribute.name property. |
| getAttributeNodeNS |
Gets an attribute object that matches the specified namespace and name. |
| getAttributeNS |
Gets the value of the specified attribute within the specified namespace. |
| getElementsByClassName |
Gets a collection of objects that are based on the value of the class attribute. |
| getElementsByTagNameNS |
Gets a collection of objects that are based on the specified element names within a specified namespace. |
| hasAttribute |
Determines whether an attribute with the specified name exists. |
| hasAttributeNS |
Determines whether an attribute that has the specified namespace and name exists. |
| hasAttributes |
Determines whether one or more attributes exist for the object. |
| insertAdjacentHTML |
Inserts the given HTML text into the element at the location. |
| insertAdjacentText |
Inserts the given text into the element at the specified location. |
| msMatchesSelector |
Determines whether an object matches the specified selector. |
| normalize |
Merges adjacent DOM objects to produce a normalized document object model. |
| removeAttributeNode |
Removes an attribute object from the object. |
| removeAttributeNS |
Removes the specified attribute from the object. |
| removeBehavior |
Detaches a behavior from the element. |
| replaceAdjacentText |
Replaces the text adjacent to the element. |
| setActive |
Sets the object as active without setting focus to the object. |
| setAttributeNode |
Sets an attribute object node as part of the object. |
| setAttributeNodeNS |
Sets an attribute object as part of the object. |
| setAttributeNS |
Sets the value of the specified attribute within the specified namespace. |
| setCapture |
Sets the mouse capture to the object that belongs to the current document. |
Properties
The ruby object has these properties.
| Property | Description |
|---|---|
|
Sets or retrieves the access key for the object. | |
|
Specifies whether the element and its contents must be selected as a whole, indivisible unit. | |
|
Retrieves a collection of attributes of the object. | |
|
Gets a value indicating whether the object can contain child objects. | |
|
Retrieves the value indicating whether the object can contain rich HTML markup. | |
|
Sets or retrieves the class of the object. | |
|
Sets or retrieves the string that indicates whether the user can edit the content of the object. | |
|
Sets or retrieves the reading order of the object. | |
|
Sets or gets the value that indicates whether the object visibly shows that it has focus. | |
|
Sets or retrieves the string identifying the object. | |
|
Sets or retrieves the HTML between the start and end tags of the object. | |
|
Sets or retrieves the text between the start and end tags of the object. | |
|
Gets the value that indicates whether the user can edit the contents of the object. | |
|
Gets the value that indicates whether the user can interact with the object. | |
|
Retrieves the value indicating whether the content of the object contains one or more lines. | |
|
Retrieves whether a TextRange object can be created using the object. | |
|
Sets or retrieves the language to use. | |
|
Sets or retrieves the language in which the current script is written. Note This has been superceded by the type attribute for the script element. If you are using javascript alone, you don't need to specify a type or language with the script element.
| |
|
Sets or retrieves the name of the object. | |
|
Retrieves the height of the object relative to the layout or coordinate parent, as specified by the offsetParent property. | |
|
Retrieves the calculated left position of the object relative to the layout or coordinate parent, as specified by the offsetParent property. | |
|
Retrieves a reference to the container object that defines the offsetTop and offsetLeft properties of the object. | |
|
Retrieves the calculated top position of the object relative to the layout or coordinate parent, as specified by the offsetParent property. | |
|
Retrieves the width of the object relative to the layout or coordinate parent, as specified by the offsetParent property. | |
|
Sets or retrieves the object and its content in HTML. | |
|
Sets or retrieves the text of the object. | |
|
Retrieves the parent object in the object hierarchy. | |
|
Retrieves the container object in the document hierarchy that can be used to create a TextRange containing the original object. | |
|
Retrieves the current state of the object. | |
|
Retrieves the ordinal record from the data set that generated the object. | |
|
Sets or retrieves the role for this element. | |
|
Gets the namespace defined for the element. This property is not supported for Windows apps using JavaScript. | |
|
Retrieves the ordinal position of the object, in source order, as the object appears in the document's all collection. | |
|
Sets an inline style for the element. | |
|
Sets or retrieves the index that defines the tab order for the object. | |
|
Retrieves the tag name of the object. | |
|
Sets or gets the URN specified in the namespace declaration. This property is not supported for Windows apps using JavaScript. | |
|
Sets or retrieves advisory information (a ToolTip) for the object. | |
|
Retrieves the element's unique number. | |
|
Determines whether data formats within content are automatically detected and (if found) converted to clickable links. |
Standards information
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 only valid object within the ruby element is the rt element. Text not contained within the ruby text object, rt, is assumed to be a part of the base.
This element is available in HTML and script as of Microsoft Internet Explorer 5.
Examples
This example uses the ruby element to specify the first string of text as the base, and the rt element to specify the second string of text as the ruby.
Code example: http://samples.msdn.microsoft.com/workshop/samples/author/dhtml/refs/ruby.htm
<ruby> Base Text <rt>Ruby Text </ruby>
See also
