Interface HTMLDocument

継承元:

Document

プロパティ:

URL, anchors, applets, body, cookie, domain, forms, images, links, referrer, title

メソッド:

close, getElementsByName, open, write, writeln

プロパティ:

• htmldocumentObject.URL

  DOMString型, 読取専用

  文書の絶対 URI [IETF RFC 2396]。
  

• htmldocumentObject.anchors

  HTMLCollection型, 読取専用

  name 属性の値を持つ文書内のアンカー (A) 要素全てのコレクション。

  Note: 後方互換上の理由で、返されるアンカーの集合には name 属性を持つアンカーだけが含まれ、 id 属性を持つものは含まれない。 [XHTML 1.0] の場合は, name 属性 (セクション 4.10 参照) は何の意味ももたず、古いユーザーエージェントのためだけに存在することに注意: 代わりに id 属性が使用される。ユーザは代わりに [DOM Level 2 Traversal] が提供するイテレータのメカニズムを選ぶべきである。

• htmldocumentObject.applets

  HTMLCollection型, 読取専用

  文書内における、アプレットを含む OBJECT 要素と APPLET (非推奨) 要素の全てのコレクション。
  

• htmldocumentObject.body

  HTMLElement型

  文書の内容を含む要素。 BODY の内容をもつ文書では, BODY 要素を返す。フレームセット文書では、最も外側の FRAMESET 要素を返す。
  

• htmldocumentObject.cookie

  DOMString型

  この変更可能な文字列プロパティは持続状態の情報を示し、それは (1) 現在のフレームまたは文書に関連し, (2) [IETF RFC 2965] のセクション 4.2.2 の cookie 非終端記号で述べられる情報を構成する。
  現在のフレームまたは文書で利用可能な持続状態の情報がない場合は、このプロパティの値は空文字列である。
  このプロパティの読み出し時は、各クッキーの名前－値の組が名前－値の組のリストに連結され、各リスト項目が ';' (セミコロン) で区切られ、一つの文字列で全てのクッキーが返される。
  このプロパティの設定時、設定される値は [IETF RFC 2965] の cookie 非終端記号を固守する文字列であるべきである; つまり、 ０個以上のクッキー属性値の続く、１個の名前－値の組になるべきである。 domain 属性が無指定ならば、新しい値の domain 属性の規定値は、現在のフレームまたは文書の絶対 URI [IETF RFC 2396] のホスト成分となる。 path 属性が無指定ならば、新しい path 属性の規定値は、現在のフレームまたは文書の URI [IETF RFC 2396] のパス成分になる。 max-age 属性が無指定なら、新しい値の max-age 属性の規定値は、ユーザーエージェントの定義する値となる。指定された名前のクッキーが現在のフレームまたは文書に既に関連付けられている場合は、新しい値は新しい属性ともに古い値・属性に置き換わる。 max-age 属性の新しい値に 0 が指定された場合、指定された名前の既存のクッキーは、クッキーの蓄積から除去される。

  Note: 継続状態の項目の属性値の組の意味論については、 [IETF RFC 2965] を参照。

  Note: ユーザーエージェントセッションの厳密な本質については、本仕様では定めない。

  設定時の例外:

  SYNTAX_ERR / DOMException

  新しい値が [IETF RFC 2965] で定義されるクッキー構文に従わない場合.

• htmldocumentObject.domain

  DOMString型, 読取専用

  文書を送ったサーバのドメイン名。ドメイン名でサーバを識別できない場合は null 。
  

• htmldocumentObject.forms

  HTMLCollection型, 読取専用

  文書内のフォーム全てのコレクション。
  

• htmldocumentObject.images

  HTMLCollection型, 読取専用

  文書内の IMG 要素全てのコレクション。後方互換のため、振る舞いは IMG 要素に限定される。

  Note: [HTML 4.01] で示唆されるように, 画像の包含に、著者は OBJECT 要素か IMG 要素を使用できる。それゆえ、文書内画像の検索にはこのプロパティを用いず、 HTML 4.01 の getElementsByTagName や XHTML 1.0 の getElementsByTagNameNS を用いることを推奨する。

• htmldocumentObject.links

  HTMLCollection型, 読取専用

  文書内で href 属性の値を持つ AREA 要素とアンカー (A) 要素全てのコレクション。
  

• htmldocumentObject.referrer

  DOMString型, 読取専用

  このページにリンクしたページの URI [IETF RFC 2396] を返す。ユーザがページに直接(リンクを通らずに、例えばブックマーク経由など) きた場合、値は空である。
  

• htmldocumentObject.title

  DOMString型

  文書の頭部にある TITLE 要素で指定される、文書のタイトル。
  

メソッド:

• htmldocumentObject.close( )

  open() で開かれた文書ストリームを閉じ、レンダリングを強制する。

  戻り値:

  (無し)

• htmldocumentObject.getElementsByName( elementName )

  [HTML 4.01] 文書では, このメソッドは elementName で与える値を name の値に持つ要素のコレクション(空でも可)を返す。 [XHTML 1.0] 文書では, このメソッドは単に名前のマッチするフォームコントロールのコレクション(空でも可)を返す。このメソッドは文字ケースを区別する。

  引数:

  elementName / DOMString

  要素の name 属性の値。
  

  戻り値:

  NodeList 型。マッチする要素。

• htmldocumentObject.open( )

  書きだすために文書ストリームを開く。対象に既に文書が存在している場合は、それをクリアする。

  Note: このメソッドと次のメソッドは、文書の構造モデルの追加または置換に解析前の HTML 文字列を用いることをユーザに許可する。執筆時において、同様の機能を持つ HTML, XHTML 両文書のための代替のメソッドが考案されていた ([DOM Level 3 Load and Save] 参照)。

  戻り値:

  (無し)

• htmldocumentObject.write( text )

  open() で開かれた文書ストリームにテキストの文字列を書き出す。関数が生成する文書は DTD に沿ったものであるとは限らず、それゆえ文書の文脈に不正な結果をもたらすかもしれないことに注意。

  引数:

  text / DOMString

  文書構造モデル内において、ある構造に解析されるべき文字列。
  

  戻り値:

  (無し)

• htmldocumentObject.writeln( text )

  open() で開かれた文書ストリームに改行文字の続くテキストの文字列を書き出す。 関数が生成する文書は DTD に沿ったものであるとは限らず、それゆえ文書の文脈に不正な結果をもたらすかもしれないことに注意。

  引数:

  text / DOMString

  文書構造モデル内において、ある構造に解析されるべき文字列。
  

  戻り値:

  (無し)

IDL 定義:

interface HTMLDocument : Document {
           attribute DOMString       title;
  readonly attribute DOMString       referrer;
  readonly attribute DOMString       domain;
  readonly attribute DOMString       URL;
           attribute HTMLElement     body;
  readonly attribute HTMLCollection  images;
  readonly attribute HTMLCollection  applets;
  readonly attribute HTMLCollection  links;
  readonly attribute HTMLCollection  forms;
  readonly attribute HTMLCollection  anchors;
           attribute DOMString       cookie;
                                        // raises(DOMException) on setting
  void               open();
  void               close();
  void               write(in DOMString text);
  void               writeln(in DOMString text);
  NodeList           getElementsByName(in DOMString elementName);
};

• Back to Document Object Model HTML
• Object Index
• Glossary
• References