comment

< html‎ | elements
Jump to: navigation, search

comment

This article is Not Ready.


W3C Recommendation

Summary

The comment syntax indicates text within an HTML document that is not displayed on the rendered page in the browser. A comment starts with <!-- and ends with -->.


Overview Table

DOM Interface Comment


Compatibility

There is no data available for topic "html", feature "comment". If you think that there should be data available, consider opening an issue.

Examples

HTML

<!-- This is a comment. Comments are not displayed in the browser -->

Notes

The COMMENT element is treated as a no-scope element and does not expose any children. The comment.length property returns the number of characters in the object.

Additional Members (MSDN)

The comment object has these types of members:


Additional Events

The comment object has these events.

Event Description
onabort Fires when the user aborts the download.
onafterupdate Fires on a databound object after successfully updating the associated data in the data source object.
onbeforecopy Fires on the source object before the selection is copied to the system clipboard.
onbeforeupdate Fires on a databound object before updating the associated data in the data source object.
oncellchange Fires when data changes in the data provider.
onchange Fires when the contents of the object or selection have changed.
ondataavailable Fires periodically as data arrives from data source objects that asynchronously transmit their data.
ondatasetchanged Fires when the data set exposed by a data source object changes.
ondatasetcomplete Fires to indicate that all data is available from the data source object.
onerror Fires when an error occurs during object loading.
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.
oninput Occurs when the text content of an element is changed through the user interface.
onlayoutcomplete Fires when the print or print preview layout process finishes filling the current LayoutRect object with content from the source document.
onload Fires immediately after the client loads the object.
onpropertychange Fires when a property changes on the object.
onreadystatechange Fires when the state of the object has changed.
onreset Fires when the user resets a form.
onresize Fires when the size of the object is about to change.
onrowenter Fires to indicate that the current row has changed in the data source and new data values are available on the object.
onrowexit Fires just before the data source control changes the current row in the object.
onrowsdelete Fires when rows are about to be deleted from the recordset.
onrowsinserted Fires just after new rows are inserted in the current recordset.
onselect Fires when the current selection changes.

 

Additional Methods

The comment object has these methods.

Method Description
addBehavior Attaches a behavior to the element.
appendChild Appends an element as a child to the object.
appendData Adds a new character string to the end of the object.
applyElement Makes the element either a child or parent of another element.
attachEvent Binds the specified function to an event, so that the function gets called whenever the event fires on the object.
clearAttributes Removes all attributes and values from the object.
cloneNode Copies a reference to the object from the document hierarchy.
componentFromPoint Returns the component located at the specified coordinates via certain events.
deleteData Removes a specified range of characters from the object.
detachEvent Unbinds the specified function from the event, so that the function stops receiving notifications when the event fires.
doScroll Simulates a click on a scroll bar component.
dragDrop Initiates a drag event.
fireEvent Fires a specified event on the object.
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.
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.
hasChildNodes Returns a value that indicates whether the object has children.
insertAdjacentElement Inserts an element at the specified location.
insertBefore Inserts an element into the document hierarchy as a child node of a parent object.
insertData Inserts a new character string in the object at a specified offset.
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.
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.
removeChild Removes a child node from the object.
removeNode Removes the object from the document hierarchy.
replaceAdjacentText Replaces the text adjacent to the element.
replaceChild Replaces an existing child element with a new child element.
replaceData Replaces a specified range of characters in the object with a new character string.
replaceNode Replaces the object with another 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.
substringData Extracts a range of characters from the object.
swapNode Exchanges the location of two objects in the document hierarchy.

 

Additional Properties

The comment object has these properties.

Property Description
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.
childElementCount Retrieves the number of immediate child nodes of the current element or a zero if the element does not contain any child nodes. childElementCount does not return all child nodes, only child nodes that are nodeType =1, or element nodes.
constructor Returns a reference to the constructor of an object.
data Sets or retrieves the URL that references the data of the object.
firstChild Gets a reference to the first child in the childNodes collection of the object.
firstElementChild Retrieves a reference to the first child element, or null if there are no child elements.
id Sets or retrieves the string identifying 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.
lastChild Gets a reference to the last child in the childNodes collection of an object.
lastElementChild Retrieves a reference to the last child element or null if there are no child elements.
length Sets or retrieves the number of objects in a collection.
nextElementSibling Retrieves a reference to the sibling element that immediately follows or null if the element does not have any sibling elements that follow it.
nextSibling Retrieves a reference to the next child of the parent for the object.
nodeName Gets the name of a particular type of node.
nodeType Retrieves the type of the requested node.
nodeValue Gets or sets the value of a node.
ownerDocument Retrieves the Document object associated with the node.
parentNode Retrieves the parent object in the document hierarchy.
previousElementSibling Retrieves a reference to the immediately preceding sibling element or null if the element does not have any preceding siblings.
previousSibling Gets a reference to the previous child of the parent for the object.
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.

This property is not supported for Metro style apps using JavaScript.

tagUrn Sets or gets the URN specified in the namespace declaration.

This property is not supported for Metro style apps using JavaScript.

text Retrieves or sets the text of the object as a string.
uniqueID Retrieves an autogenerated, unique identifier for the object.

 


See also

Related pages (MSDN)

  • HTML Comment Element

Attribution

This article contains content originally from external sources.

Portions of this content come from the Microsoft Developer Network: [Windows Internet Explorer API reference Article]