Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

custom element | custom object

Represents a user-defined element.

HTML information

Closing Tagrequired
CSS Displayinline

DOM Information

Inheritance Hierarchy

 Node
  Element
   HTMLElement
     custom

Members

The custom object has these types of members:

Events

The custom object has these events.

EventDescription
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.

drag

Fires on the source object continuously during a drag operation.

dragend

Fires on the source object when the user releases the mouse at the close of a drag operation.

dragenter

Fires on the target element when the user drags the object to a valid drop target.

dragleave

Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.

dragover

Fires on the target element continuously while the user drags the object over a valid drop target.

dragstart

Fires on the source object when the user starts to drag a text selection or selected object.

drop

Fires on the target object when the mouse button is released during a drag-and-drop operation.

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.

losecapture

Fires when the object loses the mouse capture.

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.

propertychange

Fires when a property changes on the object.

Note  The onpropertychange event is only supported in conjunction with the legacy attachEvent IE-only event registration model, which has deprecated since Internet Explorer 9 in favor of the W3C standard "addEventListener" event model.

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 custom object has these methods.

MethodDescription
addBehavior

Attaches a behavior to the element.

applyElement

Makes the element either a child or parent of another element.

attachEvent

Note   attachEvent is no longer supported. Starting with IE11, use addEventListener. For info, see Compatibility changes.

Binds the specified function to an event, so that the function gets called whenever the event fires on the object.

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.

detachEvent

Unbinds the specified function from the event, so that the function stops receiving notifications when the event fires.

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.

getAdjacentText

Returns the adjacent text string.

getAttribute

Retrieves the value of the specified attribute.

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.

getBoundingClientRect

Retrieves an object that specifies the bounds of a collection of TextRectangle objects.

getClientRects

Retrieves a collection of rectangles that describes the layout of the contents of an object or range within the client. Each rectangle describes a single line.

getElementsByClassName

Gets a collection of objects that are based on the value of the class attribute.

getElementsByTagName

Retrieves a collection of objects based on the specified element name.

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.

mergeAttributes

Copies all read/write attributes to the specified element.

msMatchesSelector

Determines whether an object matches the specified selector.

normalize

Merges adjacent DOM objects to produce a normalized document object model.

releaseCapture

Removes mouse capture from the object in the current document.

removeAttribute

Removes an attribute from an object.

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.

scrollIntoView

Causes the object to scroll into view, aligning it either at the top or bottom of the window.

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.

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 custom object has these properties.

PropertyDescription

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.

blockDirection

Gets a string value that indicates whether the content in the block element flows from left to right, or from right to left.

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.

clientHeight

Retrieves the height of the object including padding, but not including margin, border, or scroll bar.

clientLeft

Retrieves the distance between the offsetLeft property and the true left side of the client area.

clientTop

Retrieves the distance between the offsetTop property and the true top of the client area.

clientWidth

Retrieves the width of the object including padding, but not including margin, border, or scroll bar.

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.

language

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.

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.

recordNumber

Retrieves the ordinal record from the data set that generated the object.

role

Sets or retrieves the role for this element.

scopeName

Gets the namespace defined for the element.

This property is not supported for Windows Store apps using JavaScript.

scrollHeight

Retrieves the scrolling height of the object.

scrollLeft

Sets or retrieves the distance between the left edge of the object and the leftmost portion of the content currently visible in the window.

scrollTop

Sets or retrieves the distance between the top of the object and the topmost portion of the content currently visible in the window.

scrollWidth

Retrieves the scrolling width of the object.

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.

tagUrn

Sets or gets the URN specified in the namespace declaration.

This property is not supported for Windows Store apps using JavaScript.

title

Sets or retrieves advisory information (a ToolTip) for the object.

uniqueNumber

Retrieves the element's unique number.

 

Standards information

There are no standards that apply here.

Remarks

To declare a namespace, use the XMLNS attribute of the HTML element.

When defining custom tags, you must enclose custom tag definitions within an @media wrapper.

Custom tags become much more interesting when applied with a Dynamic HTML (DHTML) behavior. Dynamic HTML (DHTML) behaviors (or behaviors) and styles are applied to elements on a page the same way—using Cascading Style Sheets (CSS) attributes. More specifically, the proposed CSS behavior attribute enables a document author to specify the location of the behavior and apply that behavior to an element.

The Windows Internet Explorer support for custom tags on an HTML page requires that a namespace be defined for the tag. Otherwise, the custom tag is treated as an unknown tag when the document is parsed. Although navigating to a page with an unknown tag in Internet Explorer does not result in an error, unknown tags have the disadvantage of not being able to contain other tags, nor can they have behaviors applied to them.

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

Examples

This example uses the custom element to create custom red, green, and blue elements. These elements change the color of the text to red, green, or blue, depending on whether it is surrounded by red, green, or blue tags. In this example, the red, green, and blue tags are defined within a namespace called customtag.

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


<html XMLNS:customtag>
<head>
<style>
@media all {
    customtag\:red { color: red; }
    customtag\:green { color: green; }
    customtag\:blue { color: blue; }
}
</style>
</head>
<body>
<customtag:red>
This text is red because it is enclosed within opening
and closing customtag:red tags.
</customtag:red>
<customtag:green>
This text is green because it is enclosed within opening
and closing customtag:green tags.
</customtag:green>
<customtag:blue>
This text is blue because it is enclosed within opening
and closing customtag:blue tags.
</customtag:blue>
</body>
</html>


See also

Using Custom Tags in Internet Explorer

 

 

Show:
© 2014 Microsoft