Represents a caption or legend for the contents of the parent figure element, if any.
HTML information
| Closing Tag | required |
|---|---|
| CSS Display | block |
DOM Information
Inheritance Hierarchy
Members
The figcaption object has these types of members:
Methods
The figcaption object has these methods.
| Method | Description |
|---|---|
| appendChild |
Appends an element as a child to the object. |
| 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. |
| cloneNode |
Copies a reference to the object from the document hierarchy. |
| componentFromPoint |
Returns the component located at the specified coordinates via certain events. |
| contains |
Checks whether the given element is contained within the object. |
| 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. |
| removeAttributeNS |
Removes the specified attribute from the object. |
| removeNode |
Removes the object from the document hierarchy. |
| replaceAdjacentText |
Replaces the text adjacent to the element. |
| replaceNode |
Replaces the object with another element. |
| setActive |
Sets the object as active without setting focus to 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. |
| swapNode |
Exchanges the location of two objects in the document hierarchy. |
Properties
The figcaption object has these properties.
| Property | Description |
|---|---|
|
Sets or retrieves the access key for the object. | |
|
Retrieves a collection of attributes of the object. | |
|
Gets a value indicating whether the object can contain child objects. | |
|
Sets or retrieves the class of the object. | |
|
Returns a reference to the constructor of an 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 whether a TextRange object can be created using the object. | |
|
Sets or retrieves the language to use. | |
|
Retrieves the height 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 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. | |
|
Sets or retrieves the role for this element. | |
|
Retrieves the ordinal position of the object, in source order, as the object appears in the document's all collection. | |
|
Retrieves the tag name of the object. | |
|
Sets or retrieves advisory information (a ToolTip) for the object. | |
|
Retrieves the element's unique number. |
Standards information
There are no standards that apply here.
Remarks
The first figcaption element child of the figure element represents the caption of the figure element's contents. The figcaption element is rendered in place; to move the caption, place it as the first or the last child of the figure element.
Note If the figcaption content provides an adequate text alternative for the visual content in the image, the caption can be used as a text alternative for images in lieu of the alt attribute.
The figcaption element is only supported for webpages displayed in a Windows Store app using JavaScript. For more information, see Defining Document Compatibility.
See also
Build date: 11/28/2012