Document

ภาพรวม

Document เป็นคลาสใน Aspose.Html FOSS สำหรับ Python. สืบทอดจาก: Node.

รากของโครงสร้าง DOM.

คลาสนี้ให้ 66 วิธีการสำหรับทำงานกับวัตถุ Document ในโปรแกรม Python. วิธีการที่มีรวมถึง: __init__, add_event_listener, adopt_node, append, append_child, attach_style_sheet, clone_node, close, compare_document_position, contains, create_attribute, create_attribute_ns, และวิธีการเพิ่มเติมอีก 54 รายการ. สมาชิกสาธารณะทั้งหมดสามารถเข้าถึงได้โดยแอปพลิเคชัน Python ใด ๆ หลังจากติดตั้งแพ็กเกจ Aspose.Html FOSS สำหรับ Python. คุณสมบัติ: a_link_color, active_element, adopted_style_sheets, all, anchors, applets, และอีก 67 รายการ.

คุณสมบัติ

ชื่อ	ประเภท	การเข้าถึง	คำอธิบาย
`default_view`	``	อ่าน	อ็อบเจ็กต์ Window ต่อเอกสาร (lazy, cached).
`location`	``	อ่าน	คืนค่าอ็อบเจ็กต์ Location ของ Window ที่เกี่ยวข้อง, หรือ `None`.
`implementation`	`"DOMImplementation"`	อ่าน	อ็อบเจ็กต์ DOMImplementation ต่อเอกสาร (lazy, cached).
`dom_config`	`DOMConfiguration`	อ่าน	อ็อบเจ็กต์ DOMConfiguration ต่อเอกสาร (lazy, cached).
`url`	`str`	อ่าน	URL ของเอกสาร (WHATWG `Document.URL`), ค่าเริ่มต้น `"about:blank"`.
`document_uri`	`str`	อ่าน	URL ของเอกสารในรูปแบบสตริง (WHATWG DOM §4.5 `documentURI`).
`base_uri`	`str`	อ่าน	URL ฐานที่แก้ไขแล้วสำหรับเอกสารนี้ (WHATWG DOM `Node.baseURI`).
`referrer`	`str`	อ่าน	URL ของเอกสารอ้างอิง (WHATWG HTML Standard §document).
`domain`	`str`	อ่าน	ส่วนประกอบชื่อโฮสต์ของ URL เอกสาร (WHATWG HTML Standard §document).
`last_modified`	`str`	อ่าน	สตริงเวลาตราประทับการแก้ไขครั้งสุดท้าย (WHATWG HTML Standard §document).
`cookie`	`str`	อ่าน/เขียน	ส่วนต่อสตริงคุกกี้แบบอ่านอย่างเดียว — จะคืนค่า `""` เสมอ (WHATWG HTML §8.11.1).
`hidden`	`bool`	อ่าน	ว่าเอกสารถูกซ่อนหรือไม่ — จะต้องเป็น `False` เสมอในโหมด headless.
`visibility_state`	`str`	อ่าน	สถานะการมองเห็นของเอกสาร — จะต้องเป็น `"visible"` เสมอในโหมด headless.
`design_mode`	`str`	อ่าน/เขียน	ว่าเอกสารอยู่ในโหมดออกแบบหรือไม่ (WHATWG HTML §7.6.4).
`dir`	`str`	อ่าน/เขียน	ทิศทางข้อความของเอกสาร (WHATWG HTML §3.3.2).
`current_script`	`None`	อ่าน	องค์ประกอบสคริปต์ที่กำลังทำงานอยู่ในขณะนี้ (WHATWG HTML §8.1.3.4).
`character_set`	`str`	อ่าน	การเข้ารหัสอักขระที่ใช้ระหว่างการพาร์ส (WHATWG DOM §3.1).
`charset`	`str`	อ่าน	Alias for :attr:`character_set` (HTML ชื่อมาตรฐาน).
`input_encoding`	`str`	อ่าน	Alias for :attr:`character_set` (ชื่อความเข้ากันได้ของ WHATWG DOM).
`content_type`	`str`	อ่าน	Document MIME type; จะเป็น `"text/html"` เสมอสำหรับเอกสาร HTML.
`style_sheets`	`"StyleSheetList"`	อ่าน	รายการสไตล์ชีตของเอกสารแบบสด.
`adopted_style_sheets`	`list["CSSStyleSheet"]`	อ่าน/เขียน	รายการการนำสไตล์ชีตที่สร้างได้ระดับเอกสาร.
`node_name`	`str`	อ่าน	`'#document'`
`document_element`	`Element	None`	อ่าน
`document_type`	`DocumentType	None`	อ่าน
`compat_mode`	`str`	อ่าน/เขียน	`'BackCompat'` (quirks) หรือ `'CSS1Compat'` (no-quirks).
`ready_state`	`str`	อ่าน	สถานะการโหลดเอกสาร.
`parse_errors`	`list[ParseError]`	อ่าน	ข้อผิดพลาดการพาร์สจากการดำเนินการพาร์สครั้งล่าสุด.
`head`	`Element	None`	อ่าน
`body`	`Element	None`	อ่าน
`forms`	`"HTMLCollection"`	อ่าน	คอลเลกชันแบบเรียลไทม์ของทุกองค์ประกอบ `<form>` ในเอกสาร.
`images`	`"HTMLCollection"`	อ่าน	คอลเลกชันแบบเรียลไทม์ของทุกองค์ประกอบ `<img>` ในเอกสาร.
`links`	`"HTMLCollection"`	อ่าน	คอลเลกชันแบบเรียลไทม์ขององค์ประกอบ `<a href>` และ `<area href>`.
`scripts`	`"HTMLCollection"`	อ่าน	คอลเลกชันแบบสดของทุกองค์ประกอบ `<script>` ในเอกสาร.
`embeds`	`"HTMLCollection"`	อ่าน	คอลเลกชันสดของทายาททั้งหมดของ `<embed>`.
`applets`	`"HTMLCollection"`	อ่าน	คอลเลกชันสดของทายาททั้งหมดของ `<applet>`.
`anchors`	`"HTMLCollection"`	อ่าน	คอลเลกชันแบบไลฟ์ของอิลิเมนต์ `<a name=...>` (named anchors แบบเก่า).
`title`	`str`	อ่าน/เขียน	เนื้อหาข้อความของอิลิเมนต์ `<title>` ตัวแรกใน `<head>`.
`compatible_mode`	`str`	อ่าน	ตัวบ่งชี้โหมด quirks (WHATWG HTML §3.2.1).
`strict_error_checking`	`bool`	อ่าน/เขียน	ต้องทำ `True` เสมอในโหมด headless (DOM3 Core §1.1.1).
`first_element_child`	`“Element	None”`	อ่าน
`last_element_child`	`“Element	None”`	อ่าน
`child_element_count`	`int`	อ่าน	จำนวนลูกโดยตรงที่เป็น Element nodes.
`active_element`	`“Element	None”`	อ่าน
`full_screen_enabled`	`bool`	อ่าน	เสมอ `False` — ไม่มีการแสดงผลในโหมด headless (Fullscreen API §7).
`fullscreen_element`	`None`	อ่าน	เสมอ `None` — ไม่มีองค์ประกอบเต็มหน้าจอในโหมด headless (Fullscreen API §7).
`pointer_lock_element`	`None`	อ่าน	เสมอ `None` — ไม่มีการล็อกตัวชี้ในโหมด headless (Pointer Lock API §4).
`timeline`	`"_DocumentTimeline"`	อ่าน	โครงร่างไทม์ไลน์เอกสาร; `current_time` จะต้องเป็น `0.0` (Web Animations API §6.2).
`all`	`"_AllCollection"`	อ่าน	ทุกองค์ประกอบตามลำดับต้นไม้ (WHATWG HTML §legacy document layout interface).
`plugins`	`"HTMLCollection"`	อ่าน	นามแฝงสำหรับ :attr:`embeds` ตาม WHATWG HTML §4.1 legacy interface.
`children`	`"HTMLCollection"`	อ่าน	ลูกของเอกสารโดยตรง (WHATWG DOM §4.2.6 ParentNode).
`origin`	`str`	อ่าน	สตริงต้นกำเนิดที่ไม่โปร่งใส — เสมอ `'null'` ในโหมด headless (WHATWG DOM §4.5).
`fg_color`	`str`	อ่าน/เขียน	สะท้อนแอตทริบิวต์ระดับเอกสาร `fgColor` ที่ล้าสมัยผ่านแอตทริบิวต์ `<body>` `text`.
`bg_color`	`str`	อ่าน/เขียน	สะท้อนคุณลักษณะระดับเอกสาร `bgColor` ที่ล้าสมัยผ่านคุณลักษณะ `<body>` `bgcolor` attribute.
`link_color`	`str`	อ่าน/เขียน	สะท้อนคุณลักษณะระดับเอกสาร `linkColor` ที่ล้าสมัยผ่านคุณลักษณะ `<body>` `link` attribute.
`v_link_color`	`str`	อ่าน/เขียน	สะท้อนคุณลักษณะระดับเอกสาร `vlinkColor` ที่ล้าสมัยผ่านคุณลักษณะ `<body>` `vlink` attribute.
`a_link_color`	`str`	อ่าน/เขียน	สะท้อนแอตทริบิวต์ระดับเอกสาร `alinkColor` ที่ล้าสมัยผ่านแอตทริบิวต์ `<body>` `alink`.
`fonts`	``	อ่าน	เสมอ `None` ในโหมด headless.
`picture_in_picture_enabled`	`bool`	อ่าน	เสมอ `False` ในโหมด headless.
`picture_in_picture_element`	``	อ่าน	ใช้ `None` เสมอในโหมด headless.
`prerendering`	`bool`	อ่าน	ใช้ `False` เสมอในโหมด headless.
`node_type`	`int`	อ่าน	ค่าคงที่ประเภทโหนดจำนวนเต็มจาก `NodeType`.
`node_value`	`str	None`	อ่าน/เขียน
`text_content`	`str	None`	อ่าน/เขียน
`parent_node`	`Node	None`	อ่าน
`parent_element`	`Element	None`	อ่าน
`is_connected`	`bool`	อ่าน	ว่าโหนดนี้เป็นส่วนหนึ่งของต้นไม้โหนดของเอกสารหรือไม่ (WHATWG DOM §4.4).
`owner_document`	`Document	None`	อ่าน
`child_nodes`	`NodeList`	อ่าน	รายการ NodeList สดของโหนดลูกทั้งหมด.
`first_child`	`Node	None`	อ่าน
`last_child`	`Node	None`	อ่าน
`previous_sibling`	`Node	None`	อ่าน
`next_sibling`	`Node	None`	อ่าน

วิธีการ

ลายเซ็น	คำอธิบาย
`__init__()`	Calls init บนอินสแตนซ์ Document นี้.
`normalize_document()`	ทำให้เอกสารนี้เป็นมาตรฐานโดยใช้ semantics ของ `Node.normalize` ที่มีอยู่.
`has_focus()` → `bool`	คืนค่าว่าเอกสารมีโฟกัสหรือไม่ — เสมอ `False` ในโหมด headless.
`open(type: str, replace: str)` → `"Document"`	เปิดเอกสารเพื่อเขียน (WHATWG HTML §7.7).
`close()`	ปิดเอกสารหลังจากเขียน (WHATWG HTML §7.7).
`write()`	เขียนสตริงไปยังสตรีมของเอกสาร (WHATWG HTML §7.7).
`writeln()`	เขียนสตริงตามด้วยบรรทัดใหม่ (WHATWG HTML §7.7).
`attach_style_sheet(sheet: "CSSStyleSheet")`	แนบสไตล์ชีตไปยังเอกสารนี้.
`detach_style_sheet(sheet: "CSSStyleSheet")`	ถอดสไตล์ชีตที่เคยแนบไว้ก่อนหน้า.
`save(path: “str	pathlib.Path”, encoding: str)`
`create_element(tag_name: str)` → `"HTMLElement"`	สร้าง HTMLElement ที่เป็นของเอกสารนี้.
`create_element_ns(namespace_uri: str, qualified_name: str)` → `Element`	สร้าง Element ในเนมสเปซเฉพาะที่เป็นของเอกสารนี้.
`create_text_node(data: str)` → `Text`	สร้างโหนด Text ด้วยข้อมูลอักขระที่ให้มา.
`create_comment(data: str)` → `Comment`	สร้างโหนด Comment ด้วยข้อมูลอักขระที่ให้มา.
`create_cdata_section(data: str)` → `"CDATASection"`	สร้างโหนด CDATASection ที่เป็นของเอกสารนี้.
`create_document_fragment()` → `DocumentFragment`	สร้าง DocumentFragment ว่างที่เป็นของเอกสารนี้.
`create_event(interface: str)` → `"Event"`	สร้างอ็อบเจกต์เหตุการณ์ legacy สำหรับ interface.
`create_range()` → `"Range"`	สร้าง Range ใหม่ที่ยุบอยู่ในเอกสารนี้.
`get_selection()` → `"Selection"`	คืนอ็อบเจกต์การเลือกแบบ singleton ของเอกสารนี้.
`create_processing_instruction(target: str, data: str)` → `"ProcessingInstruction"`	สร้างโหนด ProcessingInstruction ที่เป็นของเอกสารนี้.
`create_attribute(local_name: str)` → `"Attr"`	สร้าง `Attr` ที่ไม่มี namespace และเป็นของเอกสารนี้.
`create_attribute_ns(namespace_uri: str	None, qualified_name: str)`→`“Attr”`
`create_tree_walker(root: “Node”, what_to_show: int, node_filter: “Callable[[Node], int]	None”)`→`“TreeWalker”`
`create_node_iterator(root: “Node”, what_to_show: int, node_filter: “Callable[[Node], int]	None”)`→`“NodeIterator”`
`adopt_node(node: Node)` → `Node`	Adopt node เข้าสู่เอกสารนี้ โดยย้ายออกจากต้นไม้ปัจจุบันของมัน.
`import_node(node: Node, deep: bool)` → `Node`	คืนสำเนาของ node ที่เป็นของเอกสารนี้.
`get_element_by_id(id: str)` → `Element	None`
`get_elements_by_tag_name(name: str)` → `HTMLCollection`	คืนองค์ประกอบลูกทั้งหมดที่มีชื่อแท็กที่กำหนด.
`get_elements_by_class_name(names: str)` → `HTMLCollection`	คืนองค์ประกอบลูกทั้งหมดที่มีชื่อคลาสที่กำหนดทั้งหมด.
`filter_fn(el: Element)` → `bool`	เรียก filter_fn(el) บนอินสแตนซ์ Document นี้.
`get_elements_by_name(name: str)` → `NodeList`	คืนค่าองค์ประกอบลูกทั้งหมดที่ `name` แอตทริบิวต์เท่ากับ name.
`get_elements_by_tag_name_ns(namespace: “str	None”, local_name: str)`→`list`
`prepend()`	Insert nodes ก่อนลูกแรกของเอกสารนี้.
`append()`	Append nodes เป็นลูกสุดท้ายของเอกสารนี้.
`replace_children()`	ลบลูกทั้งหมดของเอกสารนี้แล้วเพิ่ม nodes.
`query_selector(selector: str)` → `Element	None`
`query_selector_all(selector: str)` → `NodeList`	คืนค่า NodeList แบบคงที่ของทุกองค์ประกอบที่ตรงกับตัวเลือก CSS.
`get_animations()` → `list[object]`	คืนค่าแอนิเมชันระดับเอกสาร (headless stub: เสมอ `[]`).
`element_from_point(x: float, y: float)`	เสมอ `None` — headless ไม่มีเอนจินการจัดวางสำหรับการทดสอบการชน (CSSOM View §11.6).
`elements_from_point(x: float, y: float)` → `list`	เสมอ `[]` — headless ไม่มีเอนจินการจัดวางสำหรับการทดสอบการชน (CSSOM View §11.6).
`exec_command(command_id: str, show_ui: bool, value: str)` → `bool`	เสมอ `False` — คำสั่งแก้ไขแบบเก่า; ไม่มี pipeline ใน headless (WHATWG HTML §8.6.1).
`query_command_enabled(command_id: str)` → `bool`	เสมอ `False` — ไม่มีกระบวนการแก้ไขใน headless (WHATWG HTML §8.6.1).
`has_storage_access()` → `bool`	เสมอ `True` — แหล่งที่มาของ headless ถูกพิจารณาเป็นแหล่งที่ม่าเดียวกัน (Storage Access API).
`request_storage_access()`	สตับไม่มีการทำงาน — headless มีการเข้าถึง storage เสมอ; ไม่จำเป็นต้องขออนุญาตแบบ async (Storage Access API).
`get_root_node(composed: bool)` → `"Node"`	คืนค่ารากของต้นไม้ของโหนด.
`has_child_nodes()` → `bool`	คืนค่าแสดงว่าโหนดนี้มีโหนดลูกโดยตรงอย่างน้อยหนึ่งโหนดหรือไม่.
`lookup_namespace_uri(prefix: str	None)`→`str
`lookup_prefix(namespace_uri: str	None)`→`str
`is_default_namespace(namespace_uri: str	None)`→`bool`
`is_supported(feature: str, version: str	None)`→`bool`
`get_feature(feature: str, version: str	None)`→`object
`set_user_data(key: str, data: object	None, handler: object
`get_user_data(key: str)` → `object	None`
`append_child(node: Node)` → `Node`	Append node เป็นลูกสุดท้ายของโหนดนี้.
`insert_before(node: Node, reference: Node	None)`→`Node`
`remove_child(node: Node)` → `Node`	Remove node จากรายการลูกและส่งคืนค่า.
`replace_child(new_child: Node, old_child: Node)` → `Node`	Replace old_child with new_child.
`clone_node(deep: bool)` → `Node`	ส่งคืนสำเนาของโหนดนี้.
`normalize()`	ทำให้โหนดนี้และส่วนย่อยทั้งหมดของมันอยู่ในรูปแบบมาตรฐาน.
`contains(other: Node	None)`→`bool`
`compare_document_position(other: "Node")` → `int`	คืนค่า bitmask ที่อธิบายตำแหน่งของ other เทียบกับโหนดนี้.
`is_equal_node(other: Node	None)`→`bool`
`is_same_node(other_node: Node	None)`→`bool`
`add_event_listener(type: str, listener: Callable, capture: bool, once: bool)`	Register listener สำหรับเหตุการณ์ของ type.
`remove_event_listener(type: str, listener: Callable, capture: bool)`	ยกเลิกการลงทะเบียนผู้ฟังที่เคยลงทะเบียนไว้.
`dispatch_event(event: "Event")` → `bool`	Dispatch event ผ่านต้นไม้บรรพบุรุษ.

ดูเพิ่มเติม

Aspose.HTML for Python — Enterprise API Reference