rt element | rt object (Windows)

This topic has not yet been rated - Rate this topic

Designates the ruby text for the ruby element.

HTML5 A vocabulary and associated APIs for HTML and XHTML

HTML information

Closing Tag	forbidden
CSS Display	inline

DOM Information

Inheritance Hierarchy

Node

Element

Members

The rt object has these types of members:

Events
Methods
Properties

Events

The rt object has these events.

Event	Description
abort	Fires when the user aborts the download.
activate	Fires when the object is set as the active element.
beforeactivate	Fires immediately before the object is set as the active element.
blur	Fires when the object loses the input focus.
change	Fires when the contents of the object or selection have changed.
click	Fires when the user clicks the left mouse button on the object.
contextmenu	Fires when the user clicks the right mouse button in the client area, opening the context menu.
dblclick	Fires when the user double-clicks the object.
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.
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.
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.
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.
onbeforedeactivate	Fires immediately before the activeElement is changed from the current object to another object in the parent document.
onkeyup	Fires when the user releases a key.
onselect	Fires when the current selection changes.
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.
scroll	Fires when the user repositions the scroll box in the scroll bar on the object.

Methods

The rt object has these methods.

Method	Description
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	Simulates a click on a scroll bar component.
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.
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 rt object has these properties.

Property	Description
accessKey	Sets or retrieves the access key for the object.
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.
canHaveChildren	Gets a value indicating whether the object can contain child objects.
canHaveHTML	Retrieves the value indicating whether the object can contain rich HTML markup.
className	Sets or retrieves the class of the object.
contentEditable	Sets or retrieves the string that indicates whether the user can edit the content of the object.
dir	Sets or retrieves the reading order of the object.
hideFocus	Sets or gets the value that indicates whether the object visibly shows that it has focus.
id	Sets or 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.
isTextEdit	Retrieves whether a TextRange object can be created using the object.
lang	Sets or retrieves the language to use.
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.
parentTextEdit	Retrieves the container object in the document hierarchy that can be used to create a TextRange containing the original object.
readyState	Retrieves the current state of the object.
role	Sets or retrieves the role for this element.
sourceIndex	Retrieves the ordinal position of the object, in source order, as the object appears in the document's all collection.
STYLE	Sets an inline style for the element.
tabIndex	Sets or retrieves the index that defines the tab order for the object.
tagName	Retrieves the tag name of the object.
title	Sets or retrieves advisory information (a ToolTip) for the object.
uniqueNumber	Retrieves the element's unique number.

Standards information

HTML5 A vocabulary and associated APIs for HTML and XHTML

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.

The ruby text specified by the rt element is positioned above or inline with the rubyPosition property.

Examples

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

Code example: http://samples.msdn.microsoft.com/workshop/samples/author/dhtml/refs/rt.htm


<ruby>
   Base Text
   <rt>Ruby Text
</ruby>

rt element | rt object