aspose-html-net 25.5.0__py3-none-win32.whl → 25.7.0__py3-none-win32.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- aspose/assemblies/html/Aspose.HTML.dll +0 -0
- aspose/assemblies/html/WrpInterop.Aspose.Html.dll +0 -0
- aspose/html/__init__.pyi +3367 -2025
- aspose/html/collections/__init__.pyi +4 -4
- aspose/html/dom/__init__.pyi +778 -404
- aspose/html/dom/canvas/__init__.pyi +2 -2
- aspose/html/dom/css/__init__.pyi +12 -11
- aspose/html/dom/events/__init__.pyi +20 -20
- aspose/html/dom/mutations/__init__.pyi +4 -4
- aspose/html/dom/svg/__init__.pyi +2726 -1627
- aspose/html/dom/svg/datatypes/__init__.pyi +52 -52
- aspose/html/dom/svg/events/__init__.pyi +4 -4
- aspose/html/dom/svg/filters/__init__.pyi +1375 -825
- aspose/html/dom/svg/paths/__init__.pyi +42 -42
- aspose/html/rendering/__init__.pyi +8 -0
- aspose/html/window/__init__.pyi +18 -7
- aspose/html.cp310-win32.pyd +0 -0
- aspose/html.cp311-win32.pyd +0 -0
- aspose/html.cp313-win32.pyd +0 -0
- aspose/html.cp35-win32.pyd +0 -0
- aspose/html.cp36-win32.pyd +0 -0
- aspose/html.cp37-win32.pyd +0 -0
- aspose/html.cp38-win32.pyd +0 -0
- aspose/html.cp39-win32.pyd +0 -0
- aspose_html_net-25.7.0.dist-info/METADATA +224 -0
- {aspose_html_net-25.5.0.dist-info → aspose_html_net-25.7.0.dist-info}/RECORD +29 -29
- aspose_html_net-25.5.0.dist-info/METADATA +0 -114
- {aspose_html_net-25.5.0.dist-info → aspose_html_net-25.7.0.dist-info}/WHEEL +0 -0
- {aspose_html_net-25.5.0.dist-info → aspose_html_net-25.7.0.dist-info}/entry_points.txt +0 -0
- {aspose_html_net-25.5.0.dist-info → aspose_html_net-25.7.0.dist-info}/top_level.txt +0 -0
aspose/html/dom/__init__.pyi
CHANGED
@@ -58,7 +58,11 @@ class Attr(Node):
|
|
58
58
|
|
59
59
|
@overload
|
60
60
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener):
|
61
|
-
'''
|
61
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
62
|
+
|
63
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
64
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
65
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
62
66
|
|
63
67
|
:param type: The event type for which the user is registering
|
64
68
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.'''
|
@@ -66,7 +70,11 @@ class Attr(Node):
|
|
66
70
|
|
67
71
|
@overload
|
68
72
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener, use_capture : bool):
|
69
|
-
'''
|
73
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
74
|
+
|
75
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
76
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
77
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
70
78
|
|
71
79
|
:param type: The event type for which the user is registering
|
72
80
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.
|
@@ -102,27 +110,41 @@ class Attr(Node):
|
|
102
110
|
|
103
111
|
@overload
|
104
112
|
def clone_node(self) -> aspose.html.dom.Node:
|
105
|
-
'''Returns a duplicate of
|
113
|
+
'''Returns a duplicate of the node on which this method was called.
|
106
114
|
|
107
|
-
:
|
115
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners. It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener` or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
116
|
+
|
117
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document, until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
108
118
|
...
|
109
119
|
|
110
120
|
@overload
|
111
121
|
def clone_node(self, deep : bool) -> aspose.html.dom.Node:
|
112
|
-
'''Returns a duplicate of
|
122
|
+
'''Returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not.
|
113
123
|
|
114
|
-
|
115
|
-
:
|
124
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners.
|
125
|
+
It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener`
|
126
|
+
or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
127
|
+
|
128
|
+
:param deep: If , then the node and its whole subtree, including text that may be in child :py:class:`aspose.html.dom.Text` nodes, is also copied.
|
129
|
+
|
130
|
+
If , only the node will be cloned. The subtree, including any text that the node contains, is not cloned.
|
131
|
+
|
132
|
+
Note that deep has no effect on empty elements, such as the and elements.
|
133
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document,
|
134
|
+
until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
116
135
|
...
|
117
136
|
|
118
137
|
def get_platform_type(self) -> Type:
|
119
|
-
'''This method is used to retrieve ECMAScript object :py:class:`System.Type`.
|
138
|
+
'''This method is used to retrieve the ECMAScript object :py:class:`System.Type`.
|
120
139
|
|
121
|
-
:returns: The ECMAScript object
|
140
|
+
:returns: The ECMAScript object.'''
|
122
141
|
...
|
123
142
|
|
124
143
|
def dispatch_event(self, event : aspose.html.dom.events.Event) -> bool:
|
125
|
-
'''
|
144
|
+
'''Dispatches an Event at the specified :py:class:`aspose.html.dom.events.IEventTarget`, (synchronously) invoking
|
145
|
+
the affected EventListeners in the appropriate order.
|
146
|
+
The normal event processing rules (including the capturing and optional bubbling phase) also apply to events
|
147
|
+
dispatched manually with :py:func:`aspose.html.dom.events.IEventTarget.dispatch_event`.
|
126
148
|
|
127
149
|
:param event: Specifies the event type, behavior, and contextual information to be used in processing the event.
|
128
150
|
:returns: The return value of :py:func:`aspose.html.dom.EventTarget.dispatch_event` indicates whether any of the listeners which handled the event called :py:func:`aspose.html.dom.events.Event.prevent_default`.
|
@@ -130,9 +152,9 @@ class Attr(Node):
|
|
130
152
|
...
|
131
153
|
|
132
154
|
def has_child_nodes(self) -> bool:
|
133
|
-
'''Returns whether
|
155
|
+
'''Returns a boolean value indicating whether the given :py:class:`aspose.html.dom.Node` has child nodes or not.
|
134
156
|
|
135
|
-
:returns:
|
157
|
+
:returns: A boolean value that is if the node has child nodes, and otherwise.'''
|
136
158
|
...
|
137
159
|
|
138
160
|
def normalize(self):
|
@@ -148,11 +170,10 @@ class Attr(Node):
|
|
148
170
|
...
|
149
171
|
|
150
172
|
def is_same_node(self, other_node : aspose.html.dom.Node) -> bool:
|
151
|
-
'''
|
152
|
-
This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.
|
173
|
+
'''Method is a legacy alias the for the strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object).
|
153
174
|
|
154
|
-
:param other_node: The
|
155
|
-
:returns:
|
175
|
+
:param other_node: The Node to test against.
|
176
|
+
:returns: A boolean value that is if both nodes are strictly equal, if not.'''
|
156
177
|
...
|
157
178
|
|
158
179
|
def lookup_prefix(self, namespace_uri : str) -> str:
|
@@ -196,17 +217,19 @@ class Attr(Node):
|
|
196
217
|
...
|
197
218
|
|
198
219
|
def remove_child(self, child : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
199
|
-
'''Removes
|
220
|
+
'''Removes a child node from the DOM and returns the removed node.
|
200
221
|
|
201
|
-
:param child:
|
202
|
-
:returns:
|
222
|
+
:param child: A :py:class:`aspose.html.dom.Node` that is the child node to be removed from the DOM.
|
223
|
+
:returns: Unlike :py:func:`aspose.html.dom.Node.clone_node` the return value preserves the :py:class:`aspose.html.dom.events.IEventListener` objects associated with it.'''
|
203
224
|
...
|
204
225
|
|
205
226
|
def append_child(self, node : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
206
|
-
'''Adds
|
227
|
+
'''Adds a node to the end of the list of children of a specified parent node. If the given child is a reference to an existing node in the document, :py:func:`aspose.html.dom.Node.append_child` moves it from its current position to the new position (there is no requirement to remove the node from its parent node before appending it to some other node).
|
207
228
|
|
208
|
-
|
209
|
-
|
229
|
+
This means that a node can't be in two points of the document simultaneously. So if the node already has a parent, the node is first removed, then appended at the new position. The :py:func:`aspose.html.dom.Node.clone_node` method can be used to make a copy of the node before appending it under the new parent. Copies made with :py:func:`aspose.html.dom.Node.clone_node` are not be automatically kept in sync.
|
230
|
+
|
231
|
+
:param node: The node to append to the given parent node (commonly an element).
|
232
|
+
:returns: A Node that is the appended child, except when child is a :py:class:`aspose.html.dom.DocumentFragment`, in which case the empty :py:class:`aspose.html.dom.DocumentFragment` is returned.'''
|
210
233
|
...
|
211
234
|
|
212
235
|
@property
|
@@ -390,7 +413,11 @@ class CDATASection(Text):
|
|
390
413
|
|
391
414
|
@overload
|
392
415
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener):
|
393
|
-
'''
|
416
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
417
|
+
|
418
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
419
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
420
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
394
421
|
|
395
422
|
:param type: The event type for which the user is registering
|
396
423
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.'''
|
@@ -398,7 +425,11 @@ class CDATASection(Text):
|
|
398
425
|
|
399
426
|
@overload
|
400
427
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener, use_capture : bool):
|
401
|
-
'''
|
428
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
429
|
+
|
430
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
431
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
432
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
402
433
|
|
403
434
|
:param type: The event type for which the user is registering
|
404
435
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.
|
@@ -434,27 +465,41 @@ class CDATASection(Text):
|
|
434
465
|
|
435
466
|
@overload
|
436
467
|
def clone_node(self) -> aspose.html.dom.Node:
|
437
|
-
'''Returns a duplicate of
|
468
|
+
'''Returns a duplicate of the node on which this method was called.
|
438
469
|
|
439
|
-
:
|
470
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners. It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener` or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
471
|
+
|
472
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document, until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
440
473
|
...
|
441
474
|
|
442
475
|
@overload
|
443
476
|
def clone_node(self, deep : bool) -> aspose.html.dom.Node:
|
444
|
-
'''Returns a duplicate of
|
477
|
+
'''Returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not.
|
445
478
|
|
446
|
-
|
447
|
-
:
|
479
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners.
|
480
|
+
It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener`
|
481
|
+
or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
482
|
+
|
483
|
+
:param deep: If , then the node and its whole subtree, including text that may be in child :py:class:`aspose.html.dom.Text` nodes, is also copied.
|
484
|
+
|
485
|
+
If , only the node will be cloned. The subtree, including any text that the node contains, is not cloned.
|
486
|
+
|
487
|
+
Note that deep has no effect on empty elements, such as the and elements.
|
488
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document,
|
489
|
+
until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
448
490
|
...
|
449
491
|
|
450
492
|
def get_platform_type(self) -> Type:
|
451
|
-
'''This method is used to retrieve ECMAScript object :py:class:`System.Type`.
|
493
|
+
'''This method is used to retrieve the ECMAScript object :py:class:`System.Type`.
|
452
494
|
|
453
|
-
:returns: The ECMAScript object
|
495
|
+
:returns: The ECMAScript object.'''
|
454
496
|
...
|
455
497
|
|
456
498
|
def dispatch_event(self, event : aspose.html.dom.events.Event) -> bool:
|
457
|
-
'''
|
499
|
+
'''Dispatches an Event at the specified :py:class:`aspose.html.dom.events.IEventTarget`, (synchronously) invoking
|
500
|
+
the affected EventListeners in the appropriate order.
|
501
|
+
The normal event processing rules (including the capturing and optional bubbling phase) also apply to events
|
502
|
+
dispatched manually with :py:func:`aspose.html.dom.events.IEventTarget.dispatch_event`.
|
458
503
|
|
459
504
|
:param event: Specifies the event type, behavior, and contextual information to be used in processing the event.
|
460
505
|
:returns: The return value of :py:func:`aspose.html.dom.EventTarget.dispatch_event` indicates whether any of the listeners which handled the event called :py:func:`aspose.html.dom.events.Event.prevent_default`.
|
@@ -462,9 +507,9 @@ class CDATASection(Text):
|
|
462
507
|
...
|
463
508
|
|
464
509
|
def has_child_nodes(self) -> bool:
|
465
|
-
'''Returns whether
|
510
|
+
'''Returns a boolean value indicating whether the given :py:class:`aspose.html.dom.Node` has child nodes or not.
|
466
511
|
|
467
|
-
:returns:
|
512
|
+
:returns: A boolean value that is if the node has child nodes, and otherwise.'''
|
468
513
|
...
|
469
514
|
|
470
515
|
def normalize(self):
|
@@ -480,11 +525,10 @@ class CDATASection(Text):
|
|
480
525
|
...
|
481
526
|
|
482
527
|
def is_same_node(self, other_node : aspose.html.dom.Node) -> bool:
|
483
|
-
'''
|
484
|
-
This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.
|
528
|
+
'''Method is a legacy alias the for the strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object).
|
485
529
|
|
486
|
-
:param other_node: The
|
487
|
-
:returns:
|
530
|
+
:param other_node: The Node to test against.
|
531
|
+
:returns: A boolean value that is if both nodes are strictly equal, if not.'''
|
488
532
|
...
|
489
533
|
|
490
534
|
def lookup_prefix(self, namespace_uri : str) -> str:
|
@@ -528,17 +572,19 @@ class CDATASection(Text):
|
|
528
572
|
...
|
529
573
|
|
530
574
|
def remove_child(self, child : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
531
|
-
'''Removes
|
575
|
+
'''Removes a child node from the DOM and returns the removed node.
|
532
576
|
|
533
|
-
:param child:
|
534
|
-
:returns:
|
577
|
+
:param child: A :py:class:`aspose.html.dom.Node` that is the child node to be removed from the DOM.
|
578
|
+
:returns: Unlike :py:func:`aspose.html.dom.Node.clone_node` the return value preserves the :py:class:`aspose.html.dom.events.IEventListener` objects associated with it.'''
|
535
579
|
...
|
536
580
|
|
537
581
|
def append_child(self, node : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
538
|
-
'''Adds
|
582
|
+
'''Adds a node to the end of the list of children of a specified parent node. If the given child is a reference to an existing node in the document, :py:func:`aspose.html.dom.Node.append_child` moves it from its current position to the new position (there is no requirement to remove the node from its parent node before appending it to some other node).
|
539
583
|
|
540
|
-
|
541
|
-
|
584
|
+
This means that a node can't be in two points of the document simultaneously. So if the node already has a parent, the node is first removed, then appended at the new position. The :py:func:`aspose.html.dom.Node.clone_node` method can be used to make a copy of the node before appending it under the new parent. Copies made with :py:func:`aspose.html.dom.Node.clone_node` are not be automatically kept in sync.
|
585
|
+
|
586
|
+
:param node: The node to append to the given parent node (commonly an element).
|
587
|
+
:returns: A Node that is the appended child, except when child is a :py:class:`aspose.html.dom.DocumentFragment`, in which case the empty :py:class:`aspose.html.dom.DocumentFragment` is returned.'''
|
542
588
|
...
|
543
589
|
|
544
590
|
def substring_data(self, offset : int, count : int) -> str:
|
@@ -605,12 +651,12 @@ class CDATASection(Text):
|
|
605
651
|
|
606
652
|
@property
|
607
653
|
def prefix(self) -> str:
|
608
|
-
'''
|
654
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
609
655
|
...
|
610
656
|
|
611
657
|
@prefix.setter
|
612
658
|
def prefix(self, value : str):
|
613
|
-
'''
|
659
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
614
660
|
...
|
615
661
|
|
616
662
|
@property
|
@@ -771,7 +817,11 @@ class CharacterData(Node):
|
|
771
817
|
|
772
818
|
@overload
|
773
819
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener):
|
774
|
-
'''
|
820
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
821
|
+
|
822
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
823
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
824
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
775
825
|
|
776
826
|
:param type: The event type for which the user is registering
|
777
827
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.'''
|
@@ -779,7 +829,11 @@ class CharacterData(Node):
|
|
779
829
|
|
780
830
|
@overload
|
781
831
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener, use_capture : bool):
|
782
|
-
'''
|
832
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
833
|
+
|
834
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
835
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
836
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
783
837
|
|
784
838
|
:param type: The event type for which the user is registering
|
785
839
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.
|
@@ -815,27 +869,41 @@ class CharacterData(Node):
|
|
815
869
|
|
816
870
|
@overload
|
817
871
|
def clone_node(self) -> aspose.html.dom.Node:
|
818
|
-
'''Returns a duplicate of
|
872
|
+
'''Returns a duplicate of the node on which this method was called.
|
819
873
|
|
820
|
-
:
|
874
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners. It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener` or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
875
|
+
|
876
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document, until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
821
877
|
...
|
822
878
|
|
823
879
|
@overload
|
824
880
|
def clone_node(self, deep : bool) -> aspose.html.dom.Node:
|
825
|
-
'''Returns a duplicate of
|
881
|
+
'''Returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not.
|
826
882
|
|
827
|
-
|
828
|
-
:
|
883
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners.
|
884
|
+
It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener`
|
885
|
+
or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
886
|
+
|
887
|
+
:param deep: If , then the node and its whole subtree, including text that may be in child :py:class:`aspose.html.dom.Text` nodes, is also copied.
|
888
|
+
|
889
|
+
If , only the node will be cloned. The subtree, including any text that the node contains, is not cloned.
|
890
|
+
|
891
|
+
Note that deep has no effect on empty elements, such as the and elements.
|
892
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document,
|
893
|
+
until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
829
894
|
...
|
830
895
|
|
831
896
|
def get_platform_type(self) -> Type:
|
832
|
-
'''This method is used to retrieve ECMAScript object :py:class:`System.Type`.
|
897
|
+
'''This method is used to retrieve the ECMAScript object :py:class:`System.Type`.
|
833
898
|
|
834
|
-
:returns: The ECMAScript object
|
899
|
+
:returns: The ECMAScript object.'''
|
835
900
|
...
|
836
901
|
|
837
902
|
def dispatch_event(self, event : aspose.html.dom.events.Event) -> bool:
|
838
|
-
'''
|
903
|
+
'''Dispatches an Event at the specified :py:class:`aspose.html.dom.events.IEventTarget`, (synchronously) invoking
|
904
|
+
the affected EventListeners in the appropriate order.
|
905
|
+
The normal event processing rules (including the capturing and optional bubbling phase) also apply to events
|
906
|
+
dispatched manually with :py:func:`aspose.html.dom.events.IEventTarget.dispatch_event`.
|
839
907
|
|
840
908
|
:param event: Specifies the event type, behavior, and contextual information to be used in processing the event.
|
841
909
|
:returns: The return value of :py:func:`aspose.html.dom.EventTarget.dispatch_event` indicates whether any of the listeners which handled the event called :py:func:`aspose.html.dom.events.Event.prevent_default`.
|
@@ -843,9 +911,9 @@ class CharacterData(Node):
|
|
843
911
|
...
|
844
912
|
|
845
913
|
def has_child_nodes(self) -> bool:
|
846
|
-
'''Returns whether
|
914
|
+
'''Returns a boolean value indicating whether the given :py:class:`aspose.html.dom.Node` has child nodes or not.
|
847
915
|
|
848
|
-
:returns:
|
916
|
+
:returns: A boolean value that is if the node has child nodes, and otherwise.'''
|
849
917
|
...
|
850
918
|
|
851
919
|
def normalize(self):
|
@@ -861,11 +929,10 @@ class CharacterData(Node):
|
|
861
929
|
...
|
862
930
|
|
863
931
|
def is_same_node(self, other_node : aspose.html.dom.Node) -> bool:
|
864
|
-
'''
|
865
|
-
This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.
|
932
|
+
'''Method is a legacy alias the for the strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object).
|
866
933
|
|
867
|
-
:param other_node: The
|
868
|
-
:returns:
|
934
|
+
:param other_node: The Node to test against.
|
935
|
+
:returns: A boolean value that is if both nodes are strictly equal, if not.'''
|
869
936
|
...
|
870
937
|
|
871
938
|
def lookup_prefix(self, namespace_uri : str) -> str:
|
@@ -909,17 +976,19 @@ class CharacterData(Node):
|
|
909
976
|
...
|
910
977
|
|
911
978
|
def remove_child(self, child : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
912
|
-
'''Removes
|
979
|
+
'''Removes a child node from the DOM and returns the removed node.
|
913
980
|
|
914
|
-
:param child:
|
915
|
-
:returns:
|
981
|
+
:param child: A :py:class:`aspose.html.dom.Node` that is the child node to be removed from the DOM.
|
982
|
+
:returns: Unlike :py:func:`aspose.html.dom.Node.clone_node` the return value preserves the :py:class:`aspose.html.dom.events.IEventListener` objects associated with it.'''
|
916
983
|
...
|
917
984
|
|
918
985
|
def append_child(self, node : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
919
|
-
'''Adds
|
986
|
+
'''Adds a node to the end of the list of children of a specified parent node. If the given child is a reference to an existing node in the document, :py:func:`aspose.html.dom.Node.append_child` moves it from its current position to the new position (there is no requirement to remove the node from its parent node before appending it to some other node).
|
920
987
|
|
921
|
-
|
922
|
-
|
988
|
+
This means that a node can't be in two points of the document simultaneously. So if the node already has a parent, the node is first removed, then appended at the new position. The :py:func:`aspose.html.dom.Node.clone_node` method can be used to make a copy of the node before appending it under the new parent. Copies made with :py:func:`aspose.html.dom.Node.clone_node` are not be automatically kept in sync.
|
989
|
+
|
990
|
+
:param node: The node to append to the given parent node (commonly an element).
|
991
|
+
:returns: A Node that is the appended child, except when child is a :py:class:`aspose.html.dom.DocumentFragment`, in which case the empty :py:class:`aspose.html.dom.DocumentFragment` is returned.'''
|
923
992
|
...
|
924
993
|
|
925
994
|
def substring_data(self, offset : int, count : int) -> str:
|
@@ -972,12 +1041,12 @@ class CharacterData(Node):
|
|
972
1041
|
|
973
1042
|
@property
|
974
1043
|
def prefix(self) -> str:
|
975
|
-
'''
|
1044
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
976
1045
|
...
|
977
1046
|
|
978
1047
|
@prefix.setter
|
979
1048
|
def prefix(self, value : str):
|
980
|
-
'''
|
1049
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
981
1050
|
...
|
982
1051
|
|
983
1052
|
@property
|
@@ -1130,7 +1199,11 @@ class Comment(CharacterData):
|
|
1130
1199
|
|
1131
1200
|
@overload
|
1132
1201
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener):
|
1133
|
-
'''
|
1202
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
1203
|
+
|
1204
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
1205
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
1206
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
1134
1207
|
|
1135
1208
|
:param type: The event type for which the user is registering
|
1136
1209
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.'''
|
@@ -1138,7 +1211,11 @@ class Comment(CharacterData):
|
|
1138
1211
|
|
1139
1212
|
@overload
|
1140
1213
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener, use_capture : bool):
|
1141
|
-
'''
|
1214
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
1215
|
+
|
1216
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
1217
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
1218
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
1142
1219
|
|
1143
1220
|
:param type: The event type for which the user is registering
|
1144
1221
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.
|
@@ -1174,27 +1251,41 @@ class Comment(CharacterData):
|
|
1174
1251
|
|
1175
1252
|
@overload
|
1176
1253
|
def clone_node(self) -> aspose.html.dom.Node:
|
1177
|
-
'''Returns a duplicate of
|
1254
|
+
'''Returns a duplicate of the node on which this method was called.
|
1178
1255
|
|
1179
|
-
:
|
1256
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners. It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener` or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
1257
|
+
|
1258
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document, until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
1180
1259
|
...
|
1181
1260
|
|
1182
1261
|
@overload
|
1183
1262
|
def clone_node(self, deep : bool) -> aspose.html.dom.Node:
|
1184
|
-
'''Returns a duplicate of
|
1263
|
+
'''Returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not.
|
1185
1264
|
|
1186
|
-
|
1187
|
-
:
|
1265
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners.
|
1266
|
+
It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener`
|
1267
|
+
or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
1268
|
+
|
1269
|
+
:param deep: If , then the node and its whole subtree, including text that may be in child :py:class:`aspose.html.dom.Text` nodes, is also copied.
|
1270
|
+
|
1271
|
+
If , only the node will be cloned. The subtree, including any text that the node contains, is not cloned.
|
1272
|
+
|
1273
|
+
Note that deep has no effect on empty elements, such as the and elements.
|
1274
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document,
|
1275
|
+
until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
1188
1276
|
...
|
1189
1277
|
|
1190
1278
|
def get_platform_type(self) -> Type:
|
1191
|
-
'''This method is used to retrieve ECMAScript object :py:class:`System.Type`.
|
1279
|
+
'''This method is used to retrieve the ECMAScript object :py:class:`System.Type`.
|
1192
1280
|
|
1193
|
-
:returns: The ECMAScript object
|
1281
|
+
:returns: The ECMAScript object.'''
|
1194
1282
|
...
|
1195
1283
|
|
1196
1284
|
def dispatch_event(self, event : aspose.html.dom.events.Event) -> bool:
|
1197
|
-
'''
|
1285
|
+
'''Dispatches an Event at the specified :py:class:`aspose.html.dom.events.IEventTarget`, (synchronously) invoking
|
1286
|
+
the affected EventListeners in the appropriate order.
|
1287
|
+
The normal event processing rules (including the capturing and optional bubbling phase) also apply to events
|
1288
|
+
dispatched manually with :py:func:`aspose.html.dom.events.IEventTarget.dispatch_event`.
|
1198
1289
|
|
1199
1290
|
:param event: Specifies the event type, behavior, and contextual information to be used in processing the event.
|
1200
1291
|
:returns: The return value of :py:func:`aspose.html.dom.EventTarget.dispatch_event` indicates whether any of the listeners which handled the event called :py:func:`aspose.html.dom.events.Event.prevent_default`.
|
@@ -1202,9 +1293,9 @@ class Comment(CharacterData):
|
|
1202
1293
|
...
|
1203
1294
|
|
1204
1295
|
def has_child_nodes(self) -> bool:
|
1205
|
-
'''Returns whether
|
1296
|
+
'''Returns a boolean value indicating whether the given :py:class:`aspose.html.dom.Node` has child nodes or not.
|
1206
1297
|
|
1207
|
-
:returns:
|
1298
|
+
:returns: A boolean value that is if the node has child nodes, and otherwise.'''
|
1208
1299
|
...
|
1209
1300
|
|
1210
1301
|
def normalize(self):
|
@@ -1220,11 +1311,10 @@ class Comment(CharacterData):
|
|
1220
1311
|
...
|
1221
1312
|
|
1222
1313
|
def is_same_node(self, other_node : aspose.html.dom.Node) -> bool:
|
1223
|
-
'''
|
1224
|
-
This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.
|
1314
|
+
'''Method is a legacy alias the for the strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object).
|
1225
1315
|
|
1226
|
-
:param other_node: The
|
1227
|
-
:returns:
|
1316
|
+
:param other_node: The Node to test against.
|
1317
|
+
:returns: A boolean value that is if both nodes are strictly equal, if not.'''
|
1228
1318
|
...
|
1229
1319
|
|
1230
1320
|
def lookup_prefix(self, namespace_uri : str) -> str:
|
@@ -1268,17 +1358,19 @@ class Comment(CharacterData):
|
|
1268
1358
|
...
|
1269
1359
|
|
1270
1360
|
def remove_child(self, child : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
1271
|
-
'''Removes
|
1361
|
+
'''Removes a child node from the DOM and returns the removed node.
|
1272
1362
|
|
1273
|
-
:param child:
|
1274
|
-
:returns:
|
1363
|
+
:param child: A :py:class:`aspose.html.dom.Node` that is the child node to be removed from the DOM.
|
1364
|
+
:returns: Unlike :py:func:`aspose.html.dom.Node.clone_node` the return value preserves the :py:class:`aspose.html.dom.events.IEventListener` objects associated with it.'''
|
1275
1365
|
...
|
1276
1366
|
|
1277
1367
|
def append_child(self, node : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
1278
|
-
'''Adds
|
1368
|
+
'''Adds a node to the end of the list of children of a specified parent node. If the given child is a reference to an existing node in the document, :py:func:`aspose.html.dom.Node.append_child` moves it from its current position to the new position (there is no requirement to remove the node from its parent node before appending it to some other node).
|
1279
1369
|
|
1280
|
-
|
1281
|
-
|
1370
|
+
This means that a node can't be in two points of the document simultaneously. So if the node already has a parent, the node is first removed, then appended at the new position. The :py:func:`aspose.html.dom.Node.clone_node` method can be used to make a copy of the node before appending it under the new parent. Copies made with :py:func:`aspose.html.dom.Node.clone_node` are not be automatically kept in sync.
|
1371
|
+
|
1372
|
+
:param node: The node to append to the given parent node (commonly an element).
|
1373
|
+
:returns: A Node that is the appended child, except when child is a :py:class:`aspose.html.dom.DocumentFragment`, in which case the empty :py:class:`aspose.html.dom.DocumentFragment` is returned.'''
|
1282
1374
|
...
|
1283
1375
|
|
1284
1376
|
def substring_data(self, offset : int, count : int) -> str:
|
@@ -1331,12 +1423,12 @@ class Comment(CharacterData):
|
|
1331
1423
|
|
1332
1424
|
@property
|
1333
1425
|
def prefix(self) -> str:
|
1334
|
-
'''
|
1426
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
1335
1427
|
...
|
1336
1428
|
|
1337
1429
|
@prefix.setter
|
1338
1430
|
def prefix(self, value : str):
|
1339
|
-
'''
|
1431
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
1340
1432
|
...
|
1341
1433
|
|
1342
1434
|
@property
|
@@ -1667,9 +1759,9 @@ class DOMObject:
|
|
1667
1759
|
For Java and ECMAScript, DOMObject is bound to the Object type.'''
|
1668
1760
|
|
1669
1761
|
def get_platform_type(self) -> Type:
|
1670
|
-
'''This method is used to retrieve ECMAScript object :py:class:`System.Type`.
|
1762
|
+
'''This method is used to retrieve the ECMAScript object :py:class:`System.Type`.
|
1671
1763
|
|
1672
|
-
:returns: The ECMAScript object
|
1764
|
+
:returns: The ECMAScript object.'''
|
1673
1765
|
...
|
1674
1766
|
|
1675
1767
|
...
|
@@ -1679,7 +1771,11 @@ class Document(Node):
|
|
1679
1771
|
|
1680
1772
|
@overload
|
1681
1773
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener):
|
1682
|
-
'''
|
1774
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
1775
|
+
|
1776
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
1777
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
1778
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
1683
1779
|
|
1684
1780
|
:param type: The event type for which the user is registering
|
1685
1781
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.'''
|
@@ -1687,7 +1783,11 @@ class Document(Node):
|
|
1687
1783
|
|
1688
1784
|
@overload
|
1689
1785
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener, use_capture : bool):
|
1690
|
-
'''
|
1786
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
1787
|
+
|
1788
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
1789
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
1790
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
1691
1791
|
|
1692
1792
|
:param type: The event type for which the user is registering
|
1693
1793
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.
|
@@ -1723,17 +1823,28 @@ class Document(Node):
|
|
1723
1823
|
|
1724
1824
|
@overload
|
1725
1825
|
def clone_node(self) -> aspose.html.dom.Node:
|
1726
|
-
'''Returns a duplicate of
|
1826
|
+
'''Returns a duplicate of the node on which this method was called.
|
1727
1827
|
|
1728
|
-
:
|
1828
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners. It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener` or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
1829
|
+
|
1830
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document, until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
1729
1831
|
...
|
1730
1832
|
|
1731
1833
|
@overload
|
1732
1834
|
def clone_node(self, deep : bool) -> aspose.html.dom.Node:
|
1733
|
-
'''Returns a duplicate of
|
1835
|
+
'''Returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not.
|
1734
1836
|
|
1735
|
-
|
1736
|
-
:
|
1837
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners.
|
1838
|
+
It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener`
|
1839
|
+
or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
1840
|
+
|
1841
|
+
:param deep: If , then the node and its whole subtree, including text that may be in child :py:class:`aspose.html.dom.Text` nodes, is also copied.
|
1842
|
+
|
1843
|
+
If , only the node will be cloned. The subtree, including any text that the node contains, is not cloned.
|
1844
|
+
|
1845
|
+
Note that deep has no effect on empty elements, such as the and elements.
|
1846
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document,
|
1847
|
+
until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
1737
1848
|
...
|
1738
1849
|
|
1739
1850
|
@overload
|
@@ -1907,13 +2018,16 @@ class Document(Node):
|
|
1907
2018
|
...
|
1908
2019
|
|
1909
2020
|
def get_platform_type(self) -> Type:
|
1910
|
-
'''This method is used to retrieve ECMAScript object :py:class:`System.Type`.
|
2021
|
+
'''This method is used to retrieve the ECMAScript object :py:class:`System.Type`.
|
1911
2022
|
|
1912
|
-
:returns: The ECMAScript object
|
2023
|
+
:returns: The ECMAScript object.'''
|
1913
2024
|
...
|
1914
2025
|
|
1915
2026
|
def dispatch_event(self, event : aspose.html.dom.events.Event) -> bool:
|
1916
|
-
'''
|
2027
|
+
'''Dispatches an Event at the specified :py:class:`aspose.html.dom.events.IEventTarget`, (synchronously) invoking
|
2028
|
+
the affected EventListeners in the appropriate order.
|
2029
|
+
The normal event processing rules (including the capturing and optional bubbling phase) also apply to events
|
2030
|
+
dispatched manually with :py:func:`aspose.html.dom.events.IEventTarget.dispatch_event`.
|
1917
2031
|
|
1918
2032
|
:param event: Specifies the event type, behavior, and contextual information to be used in processing the event.
|
1919
2033
|
:returns: The return value of :py:func:`aspose.html.dom.EventTarget.dispatch_event` indicates whether any of the listeners which handled the event called :py:func:`aspose.html.dom.events.Event.prevent_default`.
|
@@ -1921,9 +2035,9 @@ class Document(Node):
|
|
1921
2035
|
...
|
1922
2036
|
|
1923
2037
|
def has_child_nodes(self) -> bool:
|
1924
|
-
'''Returns whether
|
2038
|
+
'''Returns a boolean value indicating whether the given :py:class:`aspose.html.dom.Node` has child nodes or not.
|
1925
2039
|
|
1926
|
-
:returns:
|
2040
|
+
:returns: A boolean value that is if the node has child nodes, and otherwise.'''
|
1927
2041
|
...
|
1928
2042
|
|
1929
2043
|
def normalize(self):
|
@@ -1939,11 +2053,10 @@ class Document(Node):
|
|
1939
2053
|
...
|
1940
2054
|
|
1941
2055
|
def is_same_node(self, other_node : aspose.html.dom.Node) -> bool:
|
1942
|
-
'''
|
1943
|
-
This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.
|
2056
|
+
'''Method is a legacy alias the for the strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object).
|
1944
2057
|
|
1945
|
-
:param other_node: The
|
1946
|
-
:returns:
|
2058
|
+
:param other_node: The Node to test against.
|
2059
|
+
:returns: A boolean value that is if both nodes are strictly equal, if not.'''
|
1947
2060
|
...
|
1948
2061
|
|
1949
2062
|
def lookup_prefix(self, namespace_uri : str) -> str:
|
@@ -1987,24 +2100,28 @@ class Document(Node):
|
|
1987
2100
|
...
|
1988
2101
|
|
1989
2102
|
def remove_child(self, child : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
1990
|
-
'''Removes
|
2103
|
+
'''Removes a child node from the DOM and returns the removed node.
|
1991
2104
|
|
1992
|
-
:param child:
|
1993
|
-
:returns:
|
2105
|
+
:param child: A :py:class:`aspose.html.dom.Node` that is the child node to be removed from the DOM.
|
2106
|
+
:returns: Unlike :py:func:`aspose.html.dom.Node.clone_node` the return value preserves the :py:class:`aspose.html.dom.events.IEventListener` objects associated with it.'''
|
1994
2107
|
...
|
1995
2108
|
|
1996
2109
|
def append_child(self, node : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
1997
|
-
'''Adds
|
2110
|
+
'''Adds a node to the end of the list of children of a specified parent node. If the given child is a reference to an existing node in the document, :py:func:`aspose.html.dom.Node.append_child` moves it from its current position to the new position (there is no requirement to remove the node from its parent node before appending it to some other node).
|
1998
2111
|
|
1999
|
-
|
2000
|
-
|
2112
|
+
This means that a node can't be in two points of the document simultaneously. So if the node already has a parent, the node is first removed, then appended at the new position. The :py:func:`aspose.html.dom.Node.clone_node` method can be used to make a copy of the node before appending it under the new parent. Copies made with :py:func:`aspose.html.dom.Node.clone_node` are not be automatically kept in sync.
|
2113
|
+
|
2114
|
+
:param node: The node to append to the given parent node (commonly an element).
|
2115
|
+
:returns: A Node that is the appended child, except when child is a :py:class:`aspose.html.dom.DocumentFragment`, in which case the empty :py:class:`aspose.html.dom.DocumentFragment` is returned.'''
|
2001
2116
|
...
|
2002
2117
|
|
2003
2118
|
def create_element(self, local_name : str) -> aspose.html.dom.Element:
|
2004
|
-
'''Creates
|
2119
|
+
'''Creates the HTML element specified by , or an if localName isn't recognized.
|
2005
2120
|
|
2006
|
-
:param local_name:
|
2007
|
-
|
2121
|
+
:param local_name: A string that specifies the type of element to be created. The of the created element is initialized
|
2122
|
+
with the value of . Don't use qualified names (like "html:a") with this method.
|
2123
|
+
When called on an HTML document, converts to lower case before creating the element.
|
2124
|
+
:returns: The new :py:class:`aspose.html.dom.Element`.'''
|
2008
2125
|
...
|
2009
2126
|
|
2010
2127
|
def create_element_ns(self, namespace_uri : str, qualified_name : str) -> aspose.html.dom.Element:
|
@@ -2016,7 +2133,7 @@ class Document(Node):
|
|
2016
2133
|
...
|
2017
2134
|
|
2018
2135
|
def create_document_fragment(self) -> aspose.html.dom.DocumentFragment:
|
2019
|
-
'''Creates
|
2136
|
+
'''Creates a new empty :py:class:`aspose.html.dom.DocumentFragment` into which DOM nodes can be added to build an offscreen DOM tree.
|
2020
2137
|
|
2021
2138
|
:returns: The :py:class:`aspose.html.dom.DocumentFragment`.'''
|
2022
2139
|
...
|
@@ -2051,17 +2168,21 @@ class Document(Node):
|
|
2051
2168
|
...
|
2052
2169
|
|
2053
2170
|
def create_attribute(self, local_name : str) -> aspose.html.dom.Attr:
|
2054
|
-
'''
|
2171
|
+
'''This method creates a new attribute node, and returns it.
|
2172
|
+
The object created is a node implementing the :py:class:`aspose.html.dom.Attr` class.
|
2173
|
+
The DOM does not enforce what sort of attributes can be added to a particular element in this manner.
|
2055
2174
|
|
2056
|
-
:param local_name:
|
2057
|
-
:returns:
|
2175
|
+
:param local_name: is a string containing the name of the attribute.
|
2176
|
+
:returns: A :py:class:`aspose.html.dom.Attr` node.'''
|
2058
2177
|
...
|
2059
2178
|
|
2060
2179
|
def create_attribute_ns(self, namespace_uri : str, qualified_name : str) -> aspose.html.dom.Attr:
|
2061
|
-
'''
|
2180
|
+
'''This method creates a new attribute node, and returns it.
|
2181
|
+
The object created is a node implementing the :py:class:`aspose.html.dom.Attr` class.
|
2182
|
+
The DOM does not enforce what sort of attributes can be added to a particular element in this manner.
|
2062
2183
|
|
2063
|
-
:param namespace_uri: The namespace URI.
|
2064
|
-
:param qualified_name:
|
2184
|
+
:param namespace_uri: The namespace URI of the attribute.
|
2185
|
+
:param qualified_name: is a string containing the name of the attribute.
|
2065
2186
|
:returns: The :py:class:`aspose.html.dom.Attr`.'''
|
2066
2187
|
...
|
2067
2188
|
|
@@ -2073,43 +2194,56 @@ class Document(Node):
|
|
2073
2194
|
...
|
2074
2195
|
|
2075
2196
|
def create_document_type(self, name : str, public_id : str, system_id : str, internal_subset : str) -> aspose.html.dom.DocumentType:
|
2076
|
-
'''
|
2197
|
+
'''The method returns a :py:class:`aspose.html.dom.DocumentType` object which can either be used
|
2198
|
+
with :py:func:`aspose.html.dom.IDOMImplementation.create_document` upon document creation or can be put into the document via methods
|
2199
|
+
like :py:func:`aspose.html.dom.Node.insert_before` or :py:func:`aspose.html.dom.Node.replace_child`.
|
2077
2200
|
|
2078
|
-
:param name:
|
2079
|
-
:param public_id:
|
2080
|
-
:param system_id:
|
2201
|
+
:param name: Is a containing the qualified name, like .
|
2202
|
+
:param public_id: Is a containing the identifier.
|
2203
|
+
:param system_id: Is a containing the identifier.
|
2081
2204
|
:param internal_subset: The internal subset.
|
2082
2205
|
:returns: The :py:class:`aspose.html.dom.DocumentType`.'''
|
2083
2206
|
...
|
2084
2207
|
|
2085
2208
|
def get_elements_by_tag_name(self, tagname : str) -> aspose.html.collections.HTMLCollection:
|
2086
|
-
'''
|
2209
|
+
'''This method returns an :py:class:`aspose.html.collections.HTMLCollection` of elements with the given tag name.
|
2087
2210
|
|
2088
|
-
|
2089
|
-
:
|
2211
|
+
The complete document is searched, including the root node.
|
2212
|
+
The returned :py:class:`aspose.html.collections.HTMLCollection` is live,
|
2213
|
+
meaning that it updates itself automatically to stay in sync with the DOM tree without having to call
|
2214
|
+
this method again.
|
2215
|
+
|
2216
|
+
:param tagname: A string representing the name of the elements. The special string represents all elements.
|
2217
|
+
:returns: A live :py:class:`aspose.html.collections.HTMLCollection` of found elements in the order they appear in the tree.'''
|
2090
2218
|
...
|
2091
2219
|
|
2092
2220
|
def get_elements_by_tag_name_ns(self, namespace_uri : str, local_name : str) -> aspose.html.collections.HTMLCollection:
|
2093
|
-
'''Returns a
|
2221
|
+
'''Returns a list of elements with the given tag name belonging to the given namespace.
|
2222
|
+
The complete document is searched, including the root node.
|
2094
2223
|
|
2095
|
-
:param namespace_uri: The namespace URI.
|
2096
|
-
:param local_name:
|
2097
|
-
:returns:
|
2224
|
+
:param namespace_uri: The namespace URI of elements to look for.
|
2225
|
+
:param local_name: Either the local name of elements to look for or the special value *, which matches all elements.
|
2226
|
+
:returns: A live :py:class:`aspose.html.collections.NodeList` of found elements in the order they appear in the tree.'''
|
2098
2227
|
...
|
2099
2228
|
|
2100
2229
|
def get_element_by_id(self, element_id : str) -> aspose.html.dom.Element:
|
2101
|
-
'''
|
2230
|
+
'''This method returns an :py:class:`aspose.html.dom.Element` object representing the element whose id property matches the specified string. Since element IDs are required to be unique if specified, they're a useful way to get access to a specific element quickly.
|
2102
2231
|
|
2103
|
-
|
2104
|
-
|
2232
|
+
If you need to get access to an element which doesn't have an ID, you can use :py:func:`aspose.html.dom.Document.query_selector` to find the element using any selector.
|
2233
|
+
|
2234
|
+
:param element_id: The ID of the element to locate. The ID is case-sensitive string which is unique within the document; only one element may have any given ID.
|
2235
|
+
:returns: An :py:class:`aspose.html.dom.Element` object describing the DOM element object matching the specified ID, or null if no matching element was found in the document.'''
|
2105
2236
|
...
|
2106
2237
|
|
2107
2238
|
def get_elements_by_class_name(self, class_names : str) -> aspose.html.collections.HTMLCollection:
|
2108
|
-
'''
|
2109
|
-
http://www.w3.org/TR/dom/
|
2239
|
+
'''This method returns an array-like object of all child elements which have all the given class name(s).
|
2110
2240
|
|
2111
|
-
|
2112
|
-
|
2241
|
+
When called on the document object, the complete document is searched, including the root node.
|
2242
|
+
You may also call this method on any element; it will return only elements which are descendants
|
2243
|
+
of the specified root element with the given class name(s).
|
2244
|
+
|
2245
|
+
:param class_names: The string that contains an unordered set of unique space-separated tokens representing classes (class names)
|
2246
|
+
:returns: A live :py:class:`aspose.html.collections.HTMLCollection` of found elements.'''
|
2113
2247
|
...
|
2114
2248
|
|
2115
2249
|
def query_selector_all(self, selector : str) -> aspose.html.collections.NodeList:
|
@@ -2220,12 +2354,12 @@ class Document(Node):
|
|
2220
2354
|
|
2221
2355
|
@property
|
2222
2356
|
def prefix(self) -> str:
|
2223
|
-
'''
|
2357
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
2224
2358
|
...
|
2225
2359
|
|
2226
2360
|
@prefix.setter
|
2227
2361
|
def prefix(self, value : str):
|
2228
|
-
'''
|
2362
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
2229
2363
|
...
|
2230
2364
|
|
2231
2365
|
@property
|
@@ -2474,7 +2608,11 @@ class DocumentFragment(Node):
|
|
2474
2608
|
|
2475
2609
|
@overload
|
2476
2610
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener):
|
2477
|
-
'''
|
2611
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
2612
|
+
|
2613
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
2614
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
2615
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
2478
2616
|
|
2479
2617
|
:param type: The event type for which the user is registering
|
2480
2618
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.'''
|
@@ -2482,7 +2620,11 @@ class DocumentFragment(Node):
|
|
2482
2620
|
|
2483
2621
|
@overload
|
2484
2622
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener, use_capture : bool):
|
2485
|
-
'''
|
2623
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
2624
|
+
|
2625
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
2626
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
2627
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
2486
2628
|
|
2487
2629
|
:param type: The event type for which the user is registering
|
2488
2630
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.
|
@@ -2518,27 +2660,41 @@ class DocumentFragment(Node):
|
|
2518
2660
|
|
2519
2661
|
@overload
|
2520
2662
|
def clone_node(self) -> aspose.html.dom.Node:
|
2521
|
-
'''Returns a duplicate of
|
2663
|
+
'''Returns a duplicate of the node on which this method was called.
|
2522
2664
|
|
2523
|
-
:
|
2665
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners. It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener` or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
2666
|
+
|
2667
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document, until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
2524
2668
|
...
|
2525
2669
|
|
2526
2670
|
@overload
|
2527
2671
|
def clone_node(self, deep : bool) -> aspose.html.dom.Node:
|
2528
|
-
'''Returns a duplicate of
|
2672
|
+
'''Returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not.
|
2529
2673
|
|
2530
|
-
|
2531
|
-
:
|
2674
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners.
|
2675
|
+
It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener`
|
2676
|
+
or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
2677
|
+
|
2678
|
+
:param deep: If , then the node and its whole subtree, including text that may be in child :py:class:`aspose.html.dom.Text` nodes, is also copied.
|
2679
|
+
|
2680
|
+
If , only the node will be cloned. The subtree, including any text that the node contains, is not cloned.
|
2681
|
+
|
2682
|
+
Note that deep has no effect on empty elements, such as the and elements.
|
2683
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document,
|
2684
|
+
until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
2532
2685
|
...
|
2533
2686
|
|
2534
2687
|
def get_platform_type(self) -> Type:
|
2535
|
-
'''This method is used to retrieve ECMAScript object :py:class:`System.Type`.
|
2688
|
+
'''This method is used to retrieve the ECMAScript object :py:class:`System.Type`.
|
2536
2689
|
|
2537
|
-
:returns: The ECMAScript object
|
2690
|
+
:returns: The ECMAScript object.'''
|
2538
2691
|
...
|
2539
2692
|
|
2540
2693
|
def dispatch_event(self, event : aspose.html.dom.events.Event) -> bool:
|
2541
|
-
'''
|
2694
|
+
'''Dispatches an Event at the specified :py:class:`aspose.html.dom.events.IEventTarget`, (synchronously) invoking
|
2695
|
+
the affected EventListeners in the appropriate order.
|
2696
|
+
The normal event processing rules (including the capturing and optional bubbling phase) also apply to events
|
2697
|
+
dispatched manually with :py:func:`aspose.html.dom.events.IEventTarget.dispatch_event`.
|
2542
2698
|
|
2543
2699
|
:param event: Specifies the event type, behavior, and contextual information to be used in processing the event.
|
2544
2700
|
:returns: The return value of :py:func:`aspose.html.dom.EventTarget.dispatch_event` indicates whether any of the listeners which handled the event called :py:func:`aspose.html.dom.events.Event.prevent_default`.
|
@@ -2546,9 +2702,9 @@ class DocumentFragment(Node):
|
|
2546
2702
|
...
|
2547
2703
|
|
2548
2704
|
def has_child_nodes(self) -> bool:
|
2549
|
-
'''Returns whether
|
2705
|
+
'''Returns a boolean value indicating whether the given :py:class:`aspose.html.dom.Node` has child nodes or not.
|
2550
2706
|
|
2551
|
-
:returns:
|
2707
|
+
:returns: A boolean value that is if the node has child nodes, and otherwise.'''
|
2552
2708
|
...
|
2553
2709
|
|
2554
2710
|
def normalize(self):
|
@@ -2564,11 +2720,10 @@ class DocumentFragment(Node):
|
|
2564
2720
|
...
|
2565
2721
|
|
2566
2722
|
def is_same_node(self, other_node : aspose.html.dom.Node) -> bool:
|
2567
|
-
'''
|
2568
|
-
This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.
|
2723
|
+
'''Method is a legacy alias the for the strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object).
|
2569
2724
|
|
2570
|
-
:param other_node: The
|
2571
|
-
:returns:
|
2725
|
+
:param other_node: The Node to test against.
|
2726
|
+
:returns: A boolean value that is if both nodes are strictly equal, if not.'''
|
2572
2727
|
...
|
2573
2728
|
|
2574
2729
|
def lookup_prefix(self, namespace_uri : str) -> str:
|
@@ -2612,17 +2767,19 @@ class DocumentFragment(Node):
|
|
2612
2767
|
...
|
2613
2768
|
|
2614
2769
|
def remove_child(self, child : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
2615
|
-
'''Removes
|
2770
|
+
'''Removes a child node from the DOM and returns the removed node.
|
2616
2771
|
|
2617
|
-
:param child:
|
2618
|
-
:returns:
|
2772
|
+
:param child: A :py:class:`aspose.html.dom.Node` that is the child node to be removed from the DOM.
|
2773
|
+
:returns: Unlike :py:func:`aspose.html.dom.Node.clone_node` the return value preserves the :py:class:`aspose.html.dom.events.IEventListener` objects associated with it.'''
|
2619
2774
|
...
|
2620
2775
|
|
2621
2776
|
def append_child(self, node : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
2622
|
-
'''Adds
|
2777
|
+
'''Adds a node to the end of the list of children of a specified parent node. If the given child is a reference to an existing node in the document, :py:func:`aspose.html.dom.Node.append_child` moves it from its current position to the new position (there is no requirement to remove the node from its parent node before appending it to some other node).
|
2623
2778
|
|
2624
|
-
|
2625
|
-
|
2779
|
+
This means that a node can't be in two points of the document simultaneously. So if the node already has a parent, the node is first removed, then appended at the new position. The :py:func:`aspose.html.dom.Node.clone_node` method can be used to make a copy of the node before appending it under the new parent. Copies made with :py:func:`aspose.html.dom.Node.clone_node` are not be automatically kept in sync.
|
2780
|
+
|
2781
|
+
:param node: The node to append to the given parent node (commonly an element).
|
2782
|
+
:returns: A Node that is the appended child, except when child is a :py:class:`aspose.html.dom.DocumentFragment`, in which case the empty :py:class:`aspose.html.dom.DocumentFragment` is returned.'''
|
2626
2783
|
...
|
2627
2784
|
|
2628
2785
|
def query_selector(self, selector : str) -> aspose.html.dom.Element:
|
@@ -2653,12 +2810,12 @@ class DocumentFragment(Node):
|
|
2653
2810
|
|
2654
2811
|
@property
|
2655
2812
|
def prefix(self) -> str:
|
2656
|
-
'''
|
2813
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
2657
2814
|
...
|
2658
2815
|
|
2659
2816
|
@prefix.setter
|
2660
2817
|
def prefix(self, value : str):
|
2661
|
-
'''
|
2818
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
2662
2819
|
...
|
2663
2820
|
|
2664
2821
|
@property
|
@@ -2837,7 +2994,11 @@ class DocumentType(Node):
|
|
2837
2994
|
|
2838
2995
|
@overload
|
2839
2996
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener):
|
2840
|
-
'''
|
2997
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
2998
|
+
|
2999
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
3000
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
3001
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
2841
3002
|
|
2842
3003
|
:param type: The event type for which the user is registering
|
2843
3004
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.'''
|
@@ -2845,7 +3006,11 @@ class DocumentType(Node):
|
|
2845
3006
|
|
2846
3007
|
@overload
|
2847
3008
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener, use_capture : bool):
|
2848
|
-
'''
|
3009
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
3010
|
+
|
3011
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
3012
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
3013
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
2849
3014
|
|
2850
3015
|
:param type: The event type for which the user is registering
|
2851
3016
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.
|
@@ -2881,27 +3046,41 @@ class DocumentType(Node):
|
|
2881
3046
|
|
2882
3047
|
@overload
|
2883
3048
|
def clone_node(self) -> aspose.html.dom.Node:
|
2884
|
-
'''Returns a duplicate of
|
3049
|
+
'''Returns a duplicate of the node on which this method was called.
|
2885
3050
|
|
2886
|
-
:
|
3051
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners. It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener` or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
3052
|
+
|
3053
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document, until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
2887
3054
|
...
|
2888
3055
|
|
2889
3056
|
@overload
|
2890
3057
|
def clone_node(self, deep : bool) -> aspose.html.dom.Node:
|
2891
|
-
'''Returns a duplicate of
|
3058
|
+
'''Returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not.
|
2892
3059
|
|
2893
|
-
|
2894
|
-
:
|
3060
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners.
|
3061
|
+
It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener`
|
3062
|
+
or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
3063
|
+
|
3064
|
+
:param deep: If , then the node and its whole subtree, including text that may be in child :py:class:`aspose.html.dom.Text` nodes, is also copied.
|
3065
|
+
|
3066
|
+
If , only the node will be cloned. The subtree, including any text that the node contains, is not cloned.
|
3067
|
+
|
3068
|
+
Note that deep has no effect on empty elements, such as the and elements.
|
3069
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document,
|
3070
|
+
until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
2895
3071
|
...
|
2896
3072
|
|
2897
3073
|
def get_platform_type(self) -> Type:
|
2898
|
-
'''This method is used to retrieve ECMAScript object :py:class:`System.Type`.
|
3074
|
+
'''This method is used to retrieve the ECMAScript object :py:class:`System.Type`.
|
2899
3075
|
|
2900
|
-
:returns: The ECMAScript object
|
3076
|
+
:returns: The ECMAScript object.'''
|
2901
3077
|
...
|
2902
3078
|
|
2903
3079
|
def dispatch_event(self, event : aspose.html.dom.events.Event) -> bool:
|
2904
|
-
'''
|
3080
|
+
'''Dispatches an Event at the specified :py:class:`aspose.html.dom.events.IEventTarget`, (synchronously) invoking
|
3081
|
+
the affected EventListeners in the appropriate order.
|
3082
|
+
The normal event processing rules (including the capturing and optional bubbling phase) also apply to events
|
3083
|
+
dispatched manually with :py:func:`aspose.html.dom.events.IEventTarget.dispatch_event`.
|
2905
3084
|
|
2906
3085
|
:param event: Specifies the event type, behavior, and contextual information to be used in processing the event.
|
2907
3086
|
:returns: The return value of :py:func:`aspose.html.dom.EventTarget.dispatch_event` indicates whether any of the listeners which handled the event called :py:func:`aspose.html.dom.events.Event.prevent_default`.
|
@@ -2909,9 +3088,9 @@ class DocumentType(Node):
|
|
2909
3088
|
...
|
2910
3089
|
|
2911
3090
|
def has_child_nodes(self) -> bool:
|
2912
|
-
'''Returns whether
|
3091
|
+
'''Returns a boolean value indicating whether the given :py:class:`aspose.html.dom.Node` has child nodes or not.
|
2913
3092
|
|
2914
|
-
:returns:
|
3093
|
+
:returns: A boolean value that is if the node has child nodes, and otherwise.'''
|
2915
3094
|
...
|
2916
3095
|
|
2917
3096
|
def normalize(self):
|
@@ -2927,11 +3106,10 @@ class DocumentType(Node):
|
|
2927
3106
|
...
|
2928
3107
|
|
2929
3108
|
def is_same_node(self, other_node : aspose.html.dom.Node) -> bool:
|
2930
|
-
'''
|
2931
|
-
This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.
|
3109
|
+
'''Method is a legacy alias the for the strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object).
|
2932
3110
|
|
2933
|
-
:param other_node: The
|
2934
|
-
:returns:
|
3111
|
+
:param other_node: The Node to test against.
|
3112
|
+
:returns: A boolean value that is if both nodes are strictly equal, if not.'''
|
2935
3113
|
...
|
2936
3114
|
|
2937
3115
|
def lookup_prefix(self, namespace_uri : str) -> str:
|
@@ -2975,17 +3153,19 @@ class DocumentType(Node):
|
|
2975
3153
|
...
|
2976
3154
|
|
2977
3155
|
def remove_child(self, child : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
2978
|
-
'''Removes
|
3156
|
+
'''Removes a child node from the DOM and returns the removed node.
|
2979
3157
|
|
2980
|
-
:param child:
|
2981
|
-
:returns:
|
3158
|
+
:param child: A :py:class:`aspose.html.dom.Node` that is the child node to be removed from the DOM.
|
3159
|
+
:returns: Unlike :py:func:`aspose.html.dom.Node.clone_node` the return value preserves the :py:class:`aspose.html.dom.events.IEventListener` objects associated with it.'''
|
2982
3160
|
...
|
2983
3161
|
|
2984
3162
|
def append_child(self, node : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
2985
|
-
'''Adds
|
3163
|
+
'''Adds a node to the end of the list of children of a specified parent node. If the given child is a reference to an existing node in the document, :py:func:`aspose.html.dom.Node.append_child` moves it from its current position to the new position (there is no requirement to remove the node from its parent node before appending it to some other node).
|
2986
3164
|
|
2987
|
-
|
2988
|
-
|
3165
|
+
This means that a node can't be in two points of the document simultaneously. So if the node already has a parent, the node is first removed, then appended at the new position. The :py:func:`aspose.html.dom.Node.clone_node` method can be used to make a copy of the node before appending it under the new parent. Copies made with :py:func:`aspose.html.dom.Node.clone_node` are not be automatically kept in sync.
|
3166
|
+
|
3167
|
+
:param node: The node to append to the given parent node (commonly an element).
|
3168
|
+
:returns: A Node that is the appended child, except when child is a :py:class:`aspose.html.dom.DocumentFragment`, in which case the empty :py:class:`aspose.html.dom.DocumentFragment` is returned.'''
|
2989
3169
|
...
|
2990
3170
|
|
2991
3171
|
@property
|
@@ -3002,12 +3182,12 @@ class DocumentType(Node):
|
|
3002
3182
|
|
3003
3183
|
@property
|
3004
3184
|
def prefix(self) -> str:
|
3005
|
-
'''
|
3185
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
3006
3186
|
...
|
3007
3187
|
|
3008
3188
|
@prefix.setter
|
3009
3189
|
def prefix(self, value : str):
|
3010
|
-
'''
|
3190
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
3011
3191
|
...
|
3012
3192
|
|
3013
3193
|
@property
|
@@ -3162,7 +3342,11 @@ class Element(Node):
|
|
3162
3342
|
|
3163
3343
|
@overload
|
3164
3344
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener):
|
3165
|
-
'''
|
3345
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
3346
|
+
|
3347
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
3348
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
3349
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
3166
3350
|
|
3167
3351
|
:param type: The event type for which the user is registering
|
3168
3352
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.'''
|
@@ -3170,7 +3354,11 @@ class Element(Node):
|
|
3170
3354
|
|
3171
3355
|
@overload
|
3172
3356
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener, use_capture : bool):
|
3173
|
-
'''
|
3357
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
3358
|
+
|
3359
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
3360
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
3361
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
3174
3362
|
|
3175
3363
|
:param type: The event type for which the user is registering
|
3176
3364
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.
|
@@ -3206,17 +3394,28 @@ class Element(Node):
|
|
3206
3394
|
|
3207
3395
|
@overload
|
3208
3396
|
def clone_node(self) -> aspose.html.dom.Node:
|
3209
|
-
'''Returns a duplicate of
|
3397
|
+
'''Returns a duplicate of the node on which this method was called.
|
3210
3398
|
|
3211
|
-
:
|
3399
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners. It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener` or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
3400
|
+
|
3401
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document, until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
3212
3402
|
...
|
3213
3403
|
|
3214
3404
|
@overload
|
3215
3405
|
def clone_node(self, deep : bool) -> aspose.html.dom.Node:
|
3216
|
-
'''Returns a duplicate of
|
3406
|
+
'''Returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not.
|
3217
3407
|
|
3218
|
-
|
3219
|
-
:
|
3408
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners.
|
3409
|
+
It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener`
|
3410
|
+
or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
3411
|
+
|
3412
|
+
:param deep: If , then the node and its whole subtree, including text that may be in child :py:class:`aspose.html.dom.Text` nodes, is also copied.
|
3413
|
+
|
3414
|
+
If , only the node will be cloned. The subtree, including any text that the node contains, is not cloned.
|
3415
|
+
|
3416
|
+
Note that deep has no effect on empty elements, such as the and elements.
|
3417
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document,
|
3418
|
+
until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
3220
3419
|
...
|
3221
3420
|
|
3222
3421
|
@overload
|
@@ -3239,13 +3438,16 @@ class Element(Node):
|
|
3239
3438
|
...
|
3240
3439
|
|
3241
3440
|
def get_platform_type(self) -> Type:
|
3242
|
-
'''This method is used to retrieve ECMAScript object :py:class:`System.Type`.
|
3441
|
+
'''This method is used to retrieve the ECMAScript object :py:class:`System.Type`.
|
3243
3442
|
|
3244
|
-
:returns: The ECMAScript object
|
3443
|
+
:returns: The ECMAScript object.'''
|
3245
3444
|
...
|
3246
3445
|
|
3247
3446
|
def dispatch_event(self, event : aspose.html.dom.events.Event) -> bool:
|
3248
|
-
'''
|
3447
|
+
'''Dispatches an Event at the specified :py:class:`aspose.html.dom.events.IEventTarget`, (synchronously) invoking
|
3448
|
+
the affected EventListeners in the appropriate order.
|
3449
|
+
The normal event processing rules (including the capturing and optional bubbling phase) also apply to events
|
3450
|
+
dispatched manually with :py:func:`aspose.html.dom.events.IEventTarget.dispatch_event`.
|
3249
3451
|
|
3250
3452
|
:param event: Specifies the event type, behavior, and contextual information to be used in processing the event.
|
3251
3453
|
:returns: The return value of :py:func:`aspose.html.dom.EventTarget.dispatch_event` indicates whether any of the listeners which handled the event called :py:func:`aspose.html.dom.events.Event.prevent_default`.
|
@@ -3253,9 +3455,9 @@ class Element(Node):
|
|
3253
3455
|
...
|
3254
3456
|
|
3255
3457
|
def has_child_nodes(self) -> bool:
|
3256
|
-
'''Returns whether
|
3458
|
+
'''Returns a boolean value indicating whether the given :py:class:`aspose.html.dom.Node` has child nodes or not.
|
3257
3459
|
|
3258
|
-
:returns:
|
3460
|
+
:returns: A boolean value that is if the node has child nodes, and otherwise.'''
|
3259
3461
|
...
|
3260
3462
|
|
3261
3463
|
def normalize(self):
|
@@ -3271,11 +3473,10 @@ class Element(Node):
|
|
3271
3473
|
...
|
3272
3474
|
|
3273
3475
|
def is_same_node(self, other_node : aspose.html.dom.Node) -> bool:
|
3274
|
-
'''
|
3275
|
-
This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.
|
3476
|
+
'''Method is a legacy alias the for the strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object).
|
3276
3477
|
|
3277
|
-
:param other_node: The
|
3278
|
-
:returns:
|
3478
|
+
:param other_node: The Node to test against.
|
3479
|
+
:returns: A boolean value that is if both nodes are strictly equal, if not.'''
|
3279
3480
|
...
|
3280
3481
|
|
3281
3482
|
def lookup_prefix(self, namespace_uri : str) -> str:
|
@@ -3319,17 +3520,19 @@ class Element(Node):
|
|
3319
3520
|
...
|
3320
3521
|
|
3321
3522
|
def remove_child(self, child : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
3322
|
-
'''Removes
|
3523
|
+
'''Removes a child node from the DOM and returns the removed node.
|
3323
3524
|
|
3324
|
-
:param child:
|
3325
|
-
:returns:
|
3525
|
+
:param child: A :py:class:`aspose.html.dom.Node` that is the child node to be removed from the DOM.
|
3526
|
+
:returns: Unlike :py:func:`aspose.html.dom.Node.clone_node` the return value preserves the :py:class:`aspose.html.dom.events.IEventListener` objects associated with it.'''
|
3326
3527
|
...
|
3327
3528
|
|
3328
3529
|
def append_child(self, node : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
3329
|
-
'''Adds
|
3530
|
+
'''Adds a node to the end of the list of children of a specified parent node. If the given child is a reference to an existing node in the document, :py:func:`aspose.html.dom.Node.append_child` moves it from its current position to the new position (there is no requirement to remove the node from its parent node before appending it to some other node).
|
3330
3531
|
|
3331
|
-
|
3332
|
-
|
3532
|
+
This means that a node can't be in two points of the document simultaneously. So if the node already has a parent, the node is first removed, then appended at the new position. The :py:func:`aspose.html.dom.Node.clone_node` method can be used to make a copy of the node before appending it under the new parent. Copies made with :py:func:`aspose.html.dom.Node.clone_node` are not be automatically kept in sync.
|
3533
|
+
|
3534
|
+
:param node: The node to append to the given parent node (commonly an element).
|
3535
|
+
:returns: A Node that is the appended child, except when child is a :py:class:`aspose.html.dom.DocumentFragment`, in which case the empty :py:class:`aspose.html.dom.DocumentFragment` is returned.'''
|
3333
3536
|
...
|
3334
3537
|
|
3335
3538
|
def get_attribute_names(self) -> List[str]:
|
@@ -3439,18 +3642,18 @@ class Element(Node):
|
|
3439
3642
|
...
|
3440
3643
|
|
3441
3644
|
def get_elements_by_tag_name(self, name : str) -> aspose.html.collections.HTMLCollection:
|
3442
|
-
'''Returns
|
3645
|
+
'''Returns :py:class:`aspose.html.collections.HTMLCollection` object containing all :py:class:`aspose.html.dom.Element` with a given tag name, in document order.
|
3443
3646
|
|
3444
|
-
:param name:
|
3445
|
-
:returns:
|
3647
|
+
:param name: String representation of tag name.
|
3648
|
+
:returns: A live :py:class:`aspose.html.collections.HTMLCollection` of found elements.'''
|
3446
3649
|
...
|
3447
3650
|
|
3448
3651
|
def get_elements_by_tag_name_ns(self, namespace_uri : str, local_name : str) -> aspose.html.collections.HTMLCollection:
|
3449
|
-
'''Returns
|
3652
|
+
'''Returns :py:class:`aspose.html.collections.HTMLCollection` object containing all :py:class:`aspose.html.dom.Element` with a given local name and namespace URI string in document order.
|
3450
3653
|
|
3451
|
-
:param namespace_uri: The namespace URI.
|
3452
|
-
:param local_name:
|
3453
|
-
:returns:
|
3654
|
+
:param namespace_uri: The namespace URI string representation.
|
3655
|
+
:param local_name: String representation of local name.
|
3656
|
+
:returns: A live :py:class:`aspose.html.collections.HTMLCollection` of found elements.'''
|
3454
3657
|
...
|
3455
3658
|
|
3456
3659
|
def remove(self):
|
@@ -3479,11 +3682,10 @@ class Element(Node):
|
|
3479
3682
|
...
|
3480
3683
|
|
3481
3684
|
def get_elements_by_class_name(self, class_names : str) -> aspose.html.collections.HTMLCollection:
|
3482
|
-
'''Returns
|
3483
|
-
http://www.w3.org/TR/dom/
|
3685
|
+
'''Returns :py:class:`aspose.html.collections.HTMLCollection` object containing all the elements within :py:class:`aspose.html.dom.Element` that have all the classes specified in argument.
|
3484
3686
|
|
3485
|
-
:param class_names: The string
|
3486
|
-
:returns:
|
3687
|
+
:param class_names: The string that contains an unordered set of unique space-separated tokens representing classes (class names)
|
3688
|
+
:returns: A live :py:class:`aspose.html.collections.HTMLCollection` of found elements.'''
|
3487
3689
|
...
|
3488
3690
|
|
3489
3691
|
@property
|
@@ -3719,7 +3921,11 @@ class Entity(Node):
|
|
3719
3921
|
|
3720
3922
|
@overload
|
3721
3923
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener):
|
3722
|
-
'''
|
3924
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
3925
|
+
|
3926
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
3927
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
3928
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
3723
3929
|
|
3724
3930
|
:param type: The event type for which the user is registering
|
3725
3931
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.'''
|
@@ -3727,7 +3933,11 @@ class Entity(Node):
|
|
3727
3933
|
|
3728
3934
|
@overload
|
3729
3935
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener, use_capture : bool):
|
3730
|
-
'''
|
3936
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
3937
|
+
|
3938
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
3939
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
3940
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
3731
3941
|
|
3732
3942
|
:param type: The event type for which the user is registering
|
3733
3943
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.
|
@@ -3763,27 +3973,41 @@ class Entity(Node):
|
|
3763
3973
|
|
3764
3974
|
@overload
|
3765
3975
|
def clone_node(self) -> aspose.html.dom.Node:
|
3766
|
-
'''Returns a duplicate of
|
3976
|
+
'''Returns a duplicate of the node on which this method was called.
|
3767
3977
|
|
3768
|
-
:
|
3978
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners. It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener` or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
3979
|
+
|
3980
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document, until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
3769
3981
|
...
|
3770
3982
|
|
3771
3983
|
@overload
|
3772
3984
|
def clone_node(self, deep : bool) -> aspose.html.dom.Node:
|
3773
|
-
'''Returns a duplicate of
|
3985
|
+
'''Returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not.
|
3774
3986
|
|
3775
|
-
|
3776
|
-
:
|
3987
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners.
|
3988
|
+
It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener`
|
3989
|
+
or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
3990
|
+
|
3991
|
+
:param deep: If , then the node and its whole subtree, including text that may be in child :py:class:`aspose.html.dom.Text` nodes, is also copied.
|
3992
|
+
|
3993
|
+
If , only the node will be cloned. The subtree, including any text that the node contains, is not cloned.
|
3994
|
+
|
3995
|
+
Note that deep has no effect on empty elements, such as the and elements.
|
3996
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document,
|
3997
|
+
until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
3777
3998
|
...
|
3778
3999
|
|
3779
4000
|
def get_platform_type(self) -> Type:
|
3780
|
-
'''This method is used to retrieve ECMAScript object :py:class:`System.Type`.
|
4001
|
+
'''This method is used to retrieve the ECMAScript object :py:class:`System.Type`.
|
3781
4002
|
|
3782
|
-
:returns: The ECMAScript object
|
4003
|
+
:returns: The ECMAScript object.'''
|
3783
4004
|
...
|
3784
4005
|
|
3785
4006
|
def dispatch_event(self, event : aspose.html.dom.events.Event) -> bool:
|
3786
|
-
'''
|
4007
|
+
'''Dispatches an Event at the specified :py:class:`aspose.html.dom.events.IEventTarget`, (synchronously) invoking
|
4008
|
+
the affected EventListeners in the appropriate order.
|
4009
|
+
The normal event processing rules (including the capturing and optional bubbling phase) also apply to events
|
4010
|
+
dispatched manually with :py:func:`aspose.html.dom.events.IEventTarget.dispatch_event`.
|
3787
4011
|
|
3788
4012
|
:param event: Specifies the event type, behavior, and contextual information to be used in processing the event.
|
3789
4013
|
:returns: The return value of :py:func:`aspose.html.dom.EventTarget.dispatch_event` indicates whether any of the listeners which handled the event called :py:func:`aspose.html.dom.events.Event.prevent_default`.
|
@@ -3791,9 +4015,9 @@ class Entity(Node):
|
|
3791
4015
|
...
|
3792
4016
|
|
3793
4017
|
def has_child_nodes(self) -> bool:
|
3794
|
-
'''Returns whether
|
4018
|
+
'''Returns a boolean value indicating whether the given :py:class:`aspose.html.dom.Node` has child nodes or not.
|
3795
4019
|
|
3796
|
-
:returns:
|
4020
|
+
:returns: A boolean value that is if the node has child nodes, and otherwise.'''
|
3797
4021
|
...
|
3798
4022
|
|
3799
4023
|
def normalize(self):
|
@@ -3809,11 +4033,10 @@ class Entity(Node):
|
|
3809
4033
|
...
|
3810
4034
|
|
3811
4035
|
def is_same_node(self, other_node : aspose.html.dom.Node) -> bool:
|
3812
|
-
'''
|
3813
|
-
This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.
|
4036
|
+
'''Method is a legacy alias the for the strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object).
|
3814
4037
|
|
3815
|
-
:param other_node: The
|
3816
|
-
:returns:
|
4038
|
+
:param other_node: The Node to test against.
|
4039
|
+
:returns: A boolean value that is if both nodes are strictly equal, if not.'''
|
3817
4040
|
...
|
3818
4041
|
|
3819
4042
|
def lookup_prefix(self, namespace_uri : str) -> str:
|
@@ -3857,17 +4080,19 @@ class Entity(Node):
|
|
3857
4080
|
...
|
3858
4081
|
|
3859
4082
|
def remove_child(self, child : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
3860
|
-
'''Removes
|
4083
|
+
'''Removes a child node from the DOM and returns the removed node.
|
3861
4084
|
|
3862
|
-
:param child:
|
3863
|
-
:returns:
|
4085
|
+
:param child: A :py:class:`aspose.html.dom.Node` that is the child node to be removed from the DOM.
|
4086
|
+
:returns: Unlike :py:func:`aspose.html.dom.Node.clone_node` the return value preserves the :py:class:`aspose.html.dom.events.IEventListener` objects associated with it.'''
|
3864
4087
|
...
|
3865
4088
|
|
3866
4089
|
def append_child(self, node : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
3867
|
-
'''Adds
|
4090
|
+
'''Adds a node to the end of the list of children of a specified parent node. If the given child is a reference to an existing node in the document, :py:func:`aspose.html.dom.Node.append_child` moves it from its current position to the new position (there is no requirement to remove the node from its parent node before appending it to some other node).
|
3868
4091
|
|
3869
|
-
|
3870
|
-
|
4092
|
+
This means that a node can't be in two points of the document simultaneously. So if the node already has a parent, the node is first removed, then appended at the new position. The :py:func:`aspose.html.dom.Node.clone_node` method can be used to make a copy of the node before appending it under the new parent. Copies made with :py:func:`aspose.html.dom.Node.clone_node` are not be automatically kept in sync.
|
4093
|
+
|
4094
|
+
:param node: The node to append to the given parent node (commonly an element).
|
4095
|
+
:returns: A Node that is the appended child, except when child is a :py:class:`aspose.html.dom.DocumentFragment`, in which case the empty :py:class:`aspose.html.dom.DocumentFragment` is returned.'''
|
3871
4096
|
...
|
3872
4097
|
|
3873
4098
|
@property
|
@@ -3884,12 +4109,12 @@ class Entity(Node):
|
|
3884
4109
|
|
3885
4110
|
@property
|
3886
4111
|
def prefix(self) -> str:
|
3887
|
-
'''
|
4112
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
3888
4113
|
...
|
3889
4114
|
|
3890
4115
|
@prefix.setter
|
3891
4116
|
def prefix(self, value : str):
|
3892
|
-
'''
|
4117
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
3893
4118
|
...
|
3894
4119
|
|
3895
4120
|
@property
|
@@ -4051,7 +4276,11 @@ class EntityReference(Node):
|
|
4051
4276
|
|
4052
4277
|
@overload
|
4053
4278
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener):
|
4054
|
-
'''
|
4279
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
4280
|
+
|
4281
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
4282
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
4283
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
4055
4284
|
|
4056
4285
|
:param type: The event type for which the user is registering
|
4057
4286
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.'''
|
@@ -4059,7 +4288,11 @@ class EntityReference(Node):
|
|
4059
4288
|
|
4060
4289
|
@overload
|
4061
4290
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener, use_capture : bool):
|
4062
|
-
'''
|
4291
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
4292
|
+
|
4293
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
4294
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
4295
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
4063
4296
|
|
4064
4297
|
:param type: The event type for which the user is registering
|
4065
4298
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.
|
@@ -4095,27 +4328,41 @@ class EntityReference(Node):
|
|
4095
4328
|
|
4096
4329
|
@overload
|
4097
4330
|
def clone_node(self) -> aspose.html.dom.Node:
|
4098
|
-
'''Returns a duplicate of
|
4331
|
+
'''Returns a duplicate of the node on which this method was called.
|
4099
4332
|
|
4100
|
-
:
|
4333
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners. It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener` or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
4334
|
+
|
4335
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document, until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
4101
4336
|
...
|
4102
4337
|
|
4103
4338
|
@overload
|
4104
4339
|
def clone_node(self, deep : bool) -> aspose.html.dom.Node:
|
4105
|
-
'''Returns a duplicate of
|
4340
|
+
'''Returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not.
|
4106
4341
|
|
4107
|
-
|
4108
|
-
:
|
4342
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners.
|
4343
|
+
It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener`
|
4344
|
+
or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
4345
|
+
|
4346
|
+
:param deep: If , then the node and its whole subtree, including text that may be in child :py:class:`aspose.html.dom.Text` nodes, is also copied.
|
4347
|
+
|
4348
|
+
If , only the node will be cloned. The subtree, including any text that the node contains, is not cloned.
|
4349
|
+
|
4350
|
+
Note that deep has no effect on empty elements, such as the and elements.
|
4351
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document,
|
4352
|
+
until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
4109
4353
|
...
|
4110
4354
|
|
4111
4355
|
def get_platform_type(self) -> Type:
|
4112
|
-
'''This method is used to retrieve ECMAScript object :py:class:`System.Type`.
|
4356
|
+
'''This method is used to retrieve the ECMAScript object :py:class:`System.Type`.
|
4113
4357
|
|
4114
|
-
:returns: The ECMAScript object
|
4358
|
+
:returns: The ECMAScript object.'''
|
4115
4359
|
...
|
4116
4360
|
|
4117
4361
|
def dispatch_event(self, event : aspose.html.dom.events.Event) -> bool:
|
4118
|
-
'''
|
4362
|
+
'''Dispatches an Event at the specified :py:class:`aspose.html.dom.events.IEventTarget`, (synchronously) invoking
|
4363
|
+
the affected EventListeners in the appropriate order.
|
4364
|
+
The normal event processing rules (including the capturing and optional bubbling phase) also apply to events
|
4365
|
+
dispatched manually with :py:func:`aspose.html.dom.events.IEventTarget.dispatch_event`.
|
4119
4366
|
|
4120
4367
|
:param event: Specifies the event type, behavior, and contextual information to be used in processing the event.
|
4121
4368
|
:returns: The return value of :py:func:`aspose.html.dom.EventTarget.dispatch_event` indicates whether any of the listeners which handled the event called :py:func:`aspose.html.dom.events.Event.prevent_default`.
|
@@ -4123,9 +4370,9 @@ class EntityReference(Node):
|
|
4123
4370
|
...
|
4124
4371
|
|
4125
4372
|
def has_child_nodes(self) -> bool:
|
4126
|
-
'''Returns whether
|
4373
|
+
'''Returns a boolean value indicating whether the given :py:class:`aspose.html.dom.Node` has child nodes or not.
|
4127
4374
|
|
4128
|
-
:returns:
|
4375
|
+
:returns: A boolean value that is if the node has child nodes, and otherwise.'''
|
4129
4376
|
...
|
4130
4377
|
|
4131
4378
|
def normalize(self):
|
@@ -4141,11 +4388,10 @@ class EntityReference(Node):
|
|
4141
4388
|
...
|
4142
4389
|
|
4143
4390
|
def is_same_node(self, other_node : aspose.html.dom.Node) -> bool:
|
4144
|
-
'''
|
4145
|
-
This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.
|
4391
|
+
'''Method is a legacy alias the for the strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object).
|
4146
4392
|
|
4147
|
-
:param other_node: The
|
4148
|
-
:returns:
|
4393
|
+
:param other_node: The Node to test against.
|
4394
|
+
:returns: A boolean value that is if both nodes are strictly equal, if not.'''
|
4149
4395
|
...
|
4150
4396
|
|
4151
4397
|
def lookup_prefix(self, namespace_uri : str) -> str:
|
@@ -4189,17 +4435,19 @@ class EntityReference(Node):
|
|
4189
4435
|
...
|
4190
4436
|
|
4191
4437
|
def remove_child(self, child : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
4192
|
-
'''Removes
|
4438
|
+
'''Removes a child node from the DOM and returns the removed node.
|
4193
4439
|
|
4194
|
-
:param child:
|
4195
|
-
:returns:
|
4440
|
+
:param child: A :py:class:`aspose.html.dom.Node` that is the child node to be removed from the DOM.
|
4441
|
+
:returns: Unlike :py:func:`aspose.html.dom.Node.clone_node` the return value preserves the :py:class:`aspose.html.dom.events.IEventListener` objects associated with it.'''
|
4196
4442
|
...
|
4197
4443
|
|
4198
4444
|
def append_child(self, node : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
4199
|
-
'''Adds
|
4445
|
+
'''Adds a node to the end of the list of children of a specified parent node. If the given child is a reference to an existing node in the document, :py:func:`aspose.html.dom.Node.append_child` moves it from its current position to the new position (there is no requirement to remove the node from its parent node before appending it to some other node).
|
4200
4446
|
|
4201
|
-
|
4202
|
-
|
4447
|
+
This means that a node can't be in two points of the document simultaneously. So if the node already has a parent, the node is first removed, then appended at the new position. The :py:func:`aspose.html.dom.Node.clone_node` method can be used to make a copy of the node before appending it under the new parent. Copies made with :py:func:`aspose.html.dom.Node.clone_node` are not be automatically kept in sync.
|
4448
|
+
|
4449
|
+
:param node: The node to append to the given parent node (commonly an element).
|
4450
|
+
:returns: A Node that is the appended child, except when child is a :py:class:`aspose.html.dom.DocumentFragment`, in which case the empty :py:class:`aspose.html.dom.DocumentFragment` is returned.'''
|
4203
4451
|
...
|
4204
4452
|
|
4205
4453
|
@property
|
@@ -4216,12 +4464,12 @@ class EntityReference(Node):
|
|
4216
4464
|
|
4217
4465
|
@property
|
4218
4466
|
def prefix(self) -> str:
|
4219
|
-
'''
|
4467
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
4220
4468
|
...
|
4221
4469
|
|
4222
4470
|
@prefix.setter
|
4223
4471
|
def prefix(self, value : str):
|
4224
|
-
'''
|
4472
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
4225
4473
|
...
|
4226
4474
|
|
4227
4475
|
@property
|
@@ -4361,7 +4609,11 @@ class EventTarget(DOMObject):
|
|
4361
4609
|
|
4362
4610
|
@overload
|
4363
4611
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener):
|
4364
|
-
'''
|
4612
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
4613
|
+
|
4614
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
4615
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
4616
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
4365
4617
|
|
4366
4618
|
:param type: The event type for which the user is registering
|
4367
4619
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.'''
|
@@ -4369,7 +4621,11 @@ class EventTarget(DOMObject):
|
|
4369
4621
|
|
4370
4622
|
@overload
|
4371
4623
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener, use_capture : bool):
|
4372
|
-
'''
|
4624
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
4625
|
+
|
4626
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
4627
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
4628
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
4373
4629
|
|
4374
4630
|
:param type: The event type for which the user is registering
|
4375
4631
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.
|
@@ -4404,13 +4660,16 @@ class EventTarget(DOMObject):
|
|
4404
4660
|
...
|
4405
4661
|
|
4406
4662
|
def get_platform_type(self) -> Type:
|
4407
|
-
'''This method is used to retrieve ECMAScript object :py:class:`System.Type`.
|
4663
|
+
'''This method is used to retrieve the ECMAScript object :py:class:`System.Type`.
|
4408
4664
|
|
4409
|
-
:returns: The ECMAScript object
|
4665
|
+
:returns: The ECMAScript object.'''
|
4410
4666
|
...
|
4411
4667
|
|
4412
4668
|
def dispatch_event(self, event : aspose.html.dom.events.Event) -> bool:
|
4413
|
-
'''
|
4669
|
+
'''Dispatches an Event at the specified :py:class:`aspose.html.dom.events.IEventTarget`, (synchronously) invoking
|
4670
|
+
the affected EventListeners in the appropriate order.
|
4671
|
+
The normal event processing rules (including the capturing and optional bubbling phase) also apply to events
|
4672
|
+
dispatched manually with :py:func:`aspose.html.dom.events.IEventTarget.dispatch_event`.
|
4414
4673
|
|
4415
4674
|
:param event: Specifies the event type, behavior, and contextual information to be used in processing the event.
|
4416
4675
|
:returns: The return value of :py:func:`aspose.html.dom.EventTarget.dispatch_event` indicates whether any of the listeners which handled the event called :py:func:`aspose.html.dom.events.Event.prevent_default`.
|
@@ -4618,7 +4877,11 @@ class Node(EventTarget):
|
|
4618
4877
|
|
4619
4878
|
@overload
|
4620
4879
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener):
|
4621
|
-
'''
|
4880
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
4881
|
+
|
4882
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
4883
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
4884
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
4622
4885
|
|
4623
4886
|
:param type: The event type for which the user is registering
|
4624
4887
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.'''
|
@@ -4626,7 +4889,11 @@ class Node(EventTarget):
|
|
4626
4889
|
|
4627
4890
|
@overload
|
4628
4891
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener, use_capture : bool):
|
4629
|
-
'''
|
4892
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
4893
|
+
|
4894
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
4895
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
4896
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
4630
4897
|
|
4631
4898
|
:param type: The event type for which the user is registering
|
4632
4899
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.
|
@@ -4662,27 +4929,41 @@ class Node(EventTarget):
|
|
4662
4929
|
|
4663
4930
|
@overload
|
4664
4931
|
def clone_node(self) -> aspose.html.dom.Node:
|
4665
|
-
'''Returns a duplicate of
|
4932
|
+
'''Returns a duplicate of the node on which this method was called.
|
4666
4933
|
|
4667
|
-
:
|
4934
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners. It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener` or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
4935
|
+
|
4936
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document, until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
4668
4937
|
...
|
4669
4938
|
|
4670
4939
|
@overload
|
4671
4940
|
def clone_node(self, deep : bool) -> aspose.html.dom.Node:
|
4672
|
-
'''Returns a duplicate of
|
4941
|
+
'''Returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not.
|
4673
4942
|
|
4674
|
-
|
4675
|
-
:
|
4943
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners.
|
4944
|
+
It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener`
|
4945
|
+
or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
4946
|
+
|
4947
|
+
:param deep: If , then the node and its whole subtree, including text that may be in child :py:class:`aspose.html.dom.Text` nodes, is also copied.
|
4948
|
+
|
4949
|
+
If , only the node will be cloned. The subtree, including any text that the node contains, is not cloned.
|
4950
|
+
|
4951
|
+
Note that deep has no effect on empty elements, such as the and elements.
|
4952
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document,
|
4953
|
+
until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
4676
4954
|
...
|
4677
4955
|
|
4678
4956
|
def get_platform_type(self) -> Type:
|
4679
|
-
'''This method is used to retrieve ECMAScript object :py:class:`System.Type`.
|
4957
|
+
'''This method is used to retrieve the ECMAScript object :py:class:`System.Type`.
|
4680
4958
|
|
4681
|
-
:returns: The ECMAScript object
|
4959
|
+
:returns: The ECMAScript object.'''
|
4682
4960
|
...
|
4683
4961
|
|
4684
4962
|
def dispatch_event(self, event : aspose.html.dom.events.Event) -> bool:
|
4685
|
-
'''
|
4963
|
+
'''Dispatches an Event at the specified :py:class:`aspose.html.dom.events.IEventTarget`, (synchronously) invoking
|
4964
|
+
the affected EventListeners in the appropriate order.
|
4965
|
+
The normal event processing rules (including the capturing and optional bubbling phase) also apply to events
|
4966
|
+
dispatched manually with :py:func:`aspose.html.dom.events.IEventTarget.dispatch_event`.
|
4686
4967
|
|
4687
4968
|
:param event: Specifies the event type, behavior, and contextual information to be used in processing the event.
|
4688
4969
|
:returns: The return value of :py:func:`aspose.html.dom.EventTarget.dispatch_event` indicates whether any of the listeners which handled the event called :py:func:`aspose.html.dom.events.Event.prevent_default`.
|
@@ -4690,9 +4971,9 @@ class Node(EventTarget):
|
|
4690
4971
|
...
|
4691
4972
|
|
4692
4973
|
def has_child_nodes(self) -> bool:
|
4693
|
-
'''Returns whether
|
4974
|
+
'''Returns a boolean value indicating whether the given :py:class:`aspose.html.dom.Node` has child nodes or not.
|
4694
4975
|
|
4695
|
-
:returns:
|
4976
|
+
:returns: A boolean value that is if the node has child nodes, and otherwise.'''
|
4696
4977
|
...
|
4697
4978
|
|
4698
4979
|
def normalize(self):
|
@@ -4708,11 +4989,10 @@ class Node(EventTarget):
|
|
4708
4989
|
...
|
4709
4990
|
|
4710
4991
|
def is_same_node(self, other_node : aspose.html.dom.Node) -> bool:
|
4711
|
-
'''
|
4712
|
-
This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.
|
4992
|
+
'''Method is a legacy alias the for the strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object).
|
4713
4993
|
|
4714
|
-
:param other_node: The
|
4715
|
-
:returns:
|
4994
|
+
:param other_node: The Node to test against.
|
4995
|
+
:returns: A boolean value that is if both nodes are strictly equal, if not.'''
|
4716
4996
|
...
|
4717
4997
|
|
4718
4998
|
def lookup_prefix(self, namespace_uri : str) -> str:
|
@@ -4756,17 +5036,19 @@ class Node(EventTarget):
|
|
4756
5036
|
...
|
4757
5037
|
|
4758
5038
|
def remove_child(self, child : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
4759
|
-
'''Removes
|
5039
|
+
'''Removes a child node from the DOM and returns the removed node.
|
4760
5040
|
|
4761
|
-
:param child:
|
4762
|
-
:returns:
|
5041
|
+
:param child: A :py:class:`aspose.html.dom.Node` that is the child node to be removed from the DOM.
|
5042
|
+
:returns: Unlike :py:func:`aspose.html.dom.Node.clone_node` the return value preserves the :py:class:`aspose.html.dom.events.IEventListener` objects associated with it.'''
|
4763
5043
|
...
|
4764
5044
|
|
4765
5045
|
def append_child(self, node : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
4766
|
-
'''Adds
|
5046
|
+
'''Adds a node to the end of the list of children of a specified parent node. If the given child is a reference to an existing node in the document, :py:func:`aspose.html.dom.Node.append_child` moves it from its current position to the new position (there is no requirement to remove the node from its parent node before appending it to some other node).
|
4767
5047
|
|
4768
|
-
|
4769
|
-
|
5048
|
+
This means that a node can't be in two points of the document simultaneously. So if the node already has a parent, the node is first removed, then appended at the new position. The :py:func:`aspose.html.dom.Node.clone_node` method can be used to make a copy of the node before appending it under the new parent. Copies made with :py:func:`aspose.html.dom.Node.clone_node` are not be automatically kept in sync.
|
5049
|
+
|
5050
|
+
:param node: The node to append to the given parent node (commonly an element).
|
5051
|
+
:returns: A Node that is the appended child, except when child is a :py:class:`aspose.html.dom.DocumentFragment`, in which case the empty :py:class:`aspose.html.dom.DocumentFragment` is returned.'''
|
4770
5052
|
...
|
4771
5053
|
|
4772
5054
|
@property
|
@@ -4783,12 +5065,12 @@ class Node(EventTarget):
|
|
4783
5065
|
|
4784
5066
|
@property
|
4785
5067
|
def prefix(self) -> str:
|
4786
|
-
'''
|
5068
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
4787
5069
|
...
|
4788
5070
|
|
4789
5071
|
@prefix.setter
|
4790
5072
|
def prefix(self, value : str):
|
4791
|
-
'''
|
5073
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
4792
5074
|
...
|
4793
5075
|
|
4794
5076
|
@property
|
@@ -4926,7 +5208,11 @@ class Notation(Node):
|
|
4926
5208
|
|
4927
5209
|
@overload
|
4928
5210
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener):
|
4929
|
-
'''
|
5211
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
5212
|
+
|
5213
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
5214
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
5215
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
4930
5216
|
|
4931
5217
|
:param type: The event type for which the user is registering
|
4932
5218
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.'''
|
@@ -4934,7 +5220,11 @@ class Notation(Node):
|
|
4934
5220
|
|
4935
5221
|
@overload
|
4936
5222
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener, use_capture : bool):
|
4937
|
-
'''
|
5223
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
5224
|
+
|
5225
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
5226
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
5227
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
4938
5228
|
|
4939
5229
|
:param type: The event type for which the user is registering
|
4940
5230
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.
|
@@ -4970,27 +5260,41 @@ class Notation(Node):
|
|
4970
5260
|
|
4971
5261
|
@overload
|
4972
5262
|
def clone_node(self) -> aspose.html.dom.Node:
|
4973
|
-
'''Returns a duplicate of
|
5263
|
+
'''Returns a duplicate of the node on which this method was called.
|
4974
5264
|
|
4975
|
-
:
|
5265
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners. It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener` or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
5266
|
+
|
5267
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document, until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
4976
5268
|
...
|
4977
5269
|
|
4978
5270
|
@overload
|
4979
5271
|
def clone_node(self, deep : bool) -> aspose.html.dom.Node:
|
4980
|
-
'''Returns a duplicate of
|
5272
|
+
'''Returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not.
|
4981
5273
|
|
4982
|
-
|
4983
|
-
:
|
5274
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners.
|
5275
|
+
It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener`
|
5276
|
+
or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
5277
|
+
|
5278
|
+
:param deep: If , then the node and its whole subtree, including text that may be in child :py:class:`aspose.html.dom.Text` nodes, is also copied.
|
5279
|
+
|
5280
|
+
If , only the node will be cloned. The subtree, including any text that the node contains, is not cloned.
|
5281
|
+
|
5282
|
+
Note that deep has no effect on empty elements, such as the and elements.
|
5283
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document,
|
5284
|
+
until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
4984
5285
|
...
|
4985
5286
|
|
4986
5287
|
def get_platform_type(self) -> Type:
|
4987
|
-
'''This method is used to retrieve ECMAScript object :py:class:`System.Type`.
|
5288
|
+
'''This method is used to retrieve the ECMAScript object :py:class:`System.Type`.
|
4988
5289
|
|
4989
|
-
:returns: The ECMAScript object
|
5290
|
+
:returns: The ECMAScript object.'''
|
4990
5291
|
...
|
4991
5292
|
|
4992
5293
|
def dispatch_event(self, event : aspose.html.dom.events.Event) -> bool:
|
4993
|
-
'''
|
5294
|
+
'''Dispatches an Event at the specified :py:class:`aspose.html.dom.events.IEventTarget`, (synchronously) invoking
|
5295
|
+
the affected EventListeners in the appropriate order.
|
5296
|
+
The normal event processing rules (including the capturing and optional bubbling phase) also apply to events
|
5297
|
+
dispatched manually with :py:func:`aspose.html.dom.events.IEventTarget.dispatch_event`.
|
4994
5298
|
|
4995
5299
|
:param event: Specifies the event type, behavior, and contextual information to be used in processing the event.
|
4996
5300
|
:returns: The return value of :py:func:`aspose.html.dom.EventTarget.dispatch_event` indicates whether any of the listeners which handled the event called :py:func:`aspose.html.dom.events.Event.prevent_default`.
|
@@ -4998,9 +5302,9 @@ class Notation(Node):
|
|
4998
5302
|
...
|
4999
5303
|
|
5000
5304
|
def has_child_nodes(self) -> bool:
|
5001
|
-
'''Returns whether
|
5305
|
+
'''Returns a boolean value indicating whether the given :py:class:`aspose.html.dom.Node` has child nodes or not.
|
5002
5306
|
|
5003
|
-
:returns:
|
5307
|
+
:returns: A boolean value that is if the node has child nodes, and otherwise.'''
|
5004
5308
|
...
|
5005
5309
|
|
5006
5310
|
def normalize(self):
|
@@ -5016,11 +5320,10 @@ class Notation(Node):
|
|
5016
5320
|
...
|
5017
5321
|
|
5018
5322
|
def is_same_node(self, other_node : aspose.html.dom.Node) -> bool:
|
5019
|
-
'''
|
5020
|
-
This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.
|
5323
|
+
'''Method is a legacy alias the for the strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object).
|
5021
5324
|
|
5022
|
-
:param other_node: The
|
5023
|
-
:returns:
|
5325
|
+
:param other_node: The Node to test against.
|
5326
|
+
:returns: A boolean value that is if both nodes are strictly equal, if not.'''
|
5024
5327
|
...
|
5025
5328
|
|
5026
5329
|
def lookup_prefix(self, namespace_uri : str) -> str:
|
@@ -5064,17 +5367,19 @@ class Notation(Node):
|
|
5064
5367
|
...
|
5065
5368
|
|
5066
5369
|
def remove_child(self, child : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
5067
|
-
'''Removes
|
5370
|
+
'''Removes a child node from the DOM and returns the removed node.
|
5068
5371
|
|
5069
|
-
:param child:
|
5070
|
-
:returns:
|
5372
|
+
:param child: A :py:class:`aspose.html.dom.Node` that is the child node to be removed from the DOM.
|
5373
|
+
:returns: Unlike :py:func:`aspose.html.dom.Node.clone_node` the return value preserves the :py:class:`aspose.html.dom.events.IEventListener` objects associated with it.'''
|
5071
5374
|
...
|
5072
5375
|
|
5073
5376
|
def append_child(self, node : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
5074
|
-
'''Adds
|
5377
|
+
'''Adds a node to the end of the list of children of a specified parent node. If the given child is a reference to an existing node in the document, :py:func:`aspose.html.dom.Node.append_child` moves it from its current position to the new position (there is no requirement to remove the node from its parent node before appending it to some other node).
|
5075
5378
|
|
5076
|
-
|
5077
|
-
|
5379
|
+
This means that a node can't be in two points of the document simultaneously. So if the node already has a parent, the node is first removed, then appended at the new position. The :py:func:`aspose.html.dom.Node.clone_node` method can be used to make a copy of the node before appending it under the new parent. Copies made with :py:func:`aspose.html.dom.Node.clone_node` are not be automatically kept in sync.
|
5380
|
+
|
5381
|
+
:param node: The node to append to the given parent node (commonly an element).
|
5382
|
+
:returns: A Node that is the appended child, except when child is a :py:class:`aspose.html.dom.DocumentFragment`, in which case the empty :py:class:`aspose.html.dom.DocumentFragment` is returned.'''
|
5078
5383
|
...
|
5079
5384
|
|
5080
5385
|
@property
|
@@ -5091,12 +5396,12 @@ class Notation(Node):
|
|
5091
5396
|
|
5092
5397
|
@property
|
5093
5398
|
def prefix(self) -> str:
|
5094
|
-
'''
|
5399
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
5095
5400
|
...
|
5096
5401
|
|
5097
5402
|
@prefix.setter
|
5098
5403
|
def prefix(self, value : str):
|
5099
|
-
'''
|
5404
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
5100
5405
|
...
|
5101
5406
|
|
5102
5407
|
@property
|
@@ -5242,7 +5547,11 @@ class ProcessingInstruction(CharacterData):
|
|
5242
5547
|
|
5243
5548
|
@overload
|
5244
5549
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener):
|
5245
|
-
'''
|
5550
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
5551
|
+
|
5552
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
5553
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
5554
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
5246
5555
|
|
5247
5556
|
:param type: The event type for which the user is registering
|
5248
5557
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.'''
|
@@ -5250,7 +5559,11 @@ class ProcessingInstruction(CharacterData):
|
|
5250
5559
|
|
5251
5560
|
@overload
|
5252
5561
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener, use_capture : bool):
|
5253
|
-
'''
|
5562
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
5563
|
+
|
5564
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
5565
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
5566
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
5254
5567
|
|
5255
5568
|
:param type: The event type for which the user is registering
|
5256
5569
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.
|
@@ -5286,27 +5599,41 @@ class ProcessingInstruction(CharacterData):
|
|
5286
5599
|
|
5287
5600
|
@overload
|
5288
5601
|
def clone_node(self) -> aspose.html.dom.Node:
|
5289
|
-
'''Returns a duplicate of
|
5602
|
+
'''Returns a duplicate of the node on which this method was called.
|
5290
5603
|
|
5291
|
-
:
|
5604
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners. It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener` or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
5605
|
+
|
5606
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document, until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
5292
5607
|
...
|
5293
5608
|
|
5294
5609
|
@overload
|
5295
5610
|
def clone_node(self, deep : bool) -> aspose.html.dom.Node:
|
5296
|
-
'''Returns a duplicate of
|
5611
|
+
'''Returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not.
|
5297
5612
|
|
5298
|
-
|
5299
|
-
:
|
5613
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners.
|
5614
|
+
It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener`
|
5615
|
+
or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
5616
|
+
|
5617
|
+
:param deep: If , then the node and its whole subtree, including text that may be in child :py:class:`aspose.html.dom.Text` nodes, is also copied.
|
5618
|
+
|
5619
|
+
If , only the node will be cloned. The subtree, including any text that the node contains, is not cloned.
|
5620
|
+
|
5621
|
+
Note that deep has no effect on empty elements, such as the and elements.
|
5622
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document,
|
5623
|
+
until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
5300
5624
|
...
|
5301
5625
|
|
5302
5626
|
def get_platform_type(self) -> Type:
|
5303
|
-
'''This method is used to retrieve ECMAScript object :py:class:`System.Type`.
|
5627
|
+
'''This method is used to retrieve the ECMAScript object :py:class:`System.Type`.
|
5304
5628
|
|
5305
|
-
:returns: The ECMAScript object
|
5629
|
+
:returns: The ECMAScript object.'''
|
5306
5630
|
...
|
5307
5631
|
|
5308
5632
|
def dispatch_event(self, event : aspose.html.dom.events.Event) -> bool:
|
5309
|
-
'''
|
5633
|
+
'''Dispatches an Event at the specified :py:class:`aspose.html.dom.events.IEventTarget`, (synchronously) invoking
|
5634
|
+
the affected EventListeners in the appropriate order.
|
5635
|
+
The normal event processing rules (including the capturing and optional bubbling phase) also apply to events
|
5636
|
+
dispatched manually with :py:func:`aspose.html.dom.events.IEventTarget.dispatch_event`.
|
5310
5637
|
|
5311
5638
|
:param event: Specifies the event type, behavior, and contextual information to be used in processing the event.
|
5312
5639
|
:returns: The return value of :py:func:`aspose.html.dom.EventTarget.dispatch_event` indicates whether any of the listeners which handled the event called :py:func:`aspose.html.dom.events.Event.prevent_default`.
|
@@ -5314,9 +5641,9 @@ class ProcessingInstruction(CharacterData):
|
|
5314
5641
|
...
|
5315
5642
|
|
5316
5643
|
def has_child_nodes(self) -> bool:
|
5317
|
-
'''Returns whether
|
5644
|
+
'''Returns a boolean value indicating whether the given :py:class:`aspose.html.dom.Node` has child nodes or not.
|
5318
5645
|
|
5319
|
-
:returns:
|
5646
|
+
:returns: A boolean value that is if the node has child nodes, and otherwise.'''
|
5320
5647
|
...
|
5321
5648
|
|
5322
5649
|
def normalize(self):
|
@@ -5332,11 +5659,10 @@ class ProcessingInstruction(CharacterData):
|
|
5332
5659
|
...
|
5333
5660
|
|
5334
5661
|
def is_same_node(self, other_node : aspose.html.dom.Node) -> bool:
|
5335
|
-
'''
|
5336
|
-
This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.
|
5662
|
+
'''Method is a legacy alias the for the strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object).
|
5337
5663
|
|
5338
|
-
:param other_node: The
|
5339
|
-
:returns:
|
5664
|
+
:param other_node: The Node to test against.
|
5665
|
+
:returns: A boolean value that is if both nodes are strictly equal, if not.'''
|
5340
5666
|
...
|
5341
5667
|
|
5342
5668
|
def lookup_prefix(self, namespace_uri : str) -> str:
|
@@ -5380,17 +5706,19 @@ class ProcessingInstruction(CharacterData):
|
|
5380
5706
|
...
|
5381
5707
|
|
5382
5708
|
def remove_child(self, child : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
5383
|
-
'''Removes
|
5709
|
+
'''Removes a child node from the DOM and returns the removed node.
|
5384
5710
|
|
5385
|
-
:param child:
|
5386
|
-
:returns:
|
5711
|
+
:param child: A :py:class:`aspose.html.dom.Node` that is the child node to be removed from the DOM.
|
5712
|
+
:returns: Unlike :py:func:`aspose.html.dom.Node.clone_node` the return value preserves the :py:class:`aspose.html.dom.events.IEventListener` objects associated with it.'''
|
5387
5713
|
...
|
5388
5714
|
|
5389
5715
|
def append_child(self, node : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
5390
|
-
'''Adds
|
5716
|
+
'''Adds a node to the end of the list of children of a specified parent node. If the given child is a reference to an existing node in the document, :py:func:`aspose.html.dom.Node.append_child` moves it from its current position to the new position (there is no requirement to remove the node from its parent node before appending it to some other node).
|
5391
5717
|
|
5392
|
-
|
5393
|
-
|
5718
|
+
This means that a node can't be in two points of the document simultaneously. So if the node already has a parent, the node is first removed, then appended at the new position. The :py:func:`aspose.html.dom.Node.clone_node` method can be used to make a copy of the node before appending it under the new parent. Copies made with :py:func:`aspose.html.dom.Node.clone_node` are not be automatically kept in sync.
|
5719
|
+
|
5720
|
+
:param node: The node to append to the given parent node (commonly an element).
|
5721
|
+
:returns: A Node that is the appended child, except when child is a :py:class:`aspose.html.dom.DocumentFragment`, in which case the empty :py:class:`aspose.html.dom.DocumentFragment` is returned.'''
|
5394
5722
|
...
|
5395
5723
|
|
5396
5724
|
def substring_data(self, offset : int, count : int) -> str:
|
@@ -5443,12 +5771,12 @@ class ProcessingInstruction(CharacterData):
|
|
5443
5771
|
|
5444
5772
|
@property
|
5445
5773
|
def prefix(self) -> str:
|
5446
|
-
'''
|
5774
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
5447
5775
|
...
|
5448
5776
|
|
5449
5777
|
@prefix.setter
|
5450
5778
|
def prefix(self, value : str):
|
5451
|
-
'''
|
5779
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
5452
5780
|
...
|
5453
5781
|
|
5454
5782
|
@property
|
@@ -5636,7 +5964,11 @@ class ShadowRoot(DocumentFragment):
|
|
5636
5964
|
|
5637
5965
|
@overload
|
5638
5966
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener):
|
5639
|
-
'''
|
5967
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
5968
|
+
|
5969
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
5970
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
5971
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
5640
5972
|
|
5641
5973
|
:param type: The event type for which the user is registering
|
5642
5974
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.'''
|
@@ -5644,7 +5976,11 @@ class ShadowRoot(DocumentFragment):
|
|
5644
5976
|
|
5645
5977
|
@overload
|
5646
5978
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener, use_capture : bool):
|
5647
|
-
'''
|
5979
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
5980
|
+
|
5981
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
5982
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
5983
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
5648
5984
|
|
5649
5985
|
:param type: The event type for which the user is registering
|
5650
5986
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.
|
@@ -5680,27 +6016,41 @@ class ShadowRoot(DocumentFragment):
|
|
5680
6016
|
|
5681
6017
|
@overload
|
5682
6018
|
def clone_node(self) -> aspose.html.dom.Node:
|
5683
|
-
'''Returns a duplicate of
|
6019
|
+
'''Returns a duplicate of the node on which this method was called.
|
5684
6020
|
|
5685
|
-
:
|
6021
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners. It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener` or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
6022
|
+
|
6023
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document, until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
5686
6024
|
...
|
5687
6025
|
|
5688
6026
|
@overload
|
5689
6027
|
def clone_node(self, deep : bool) -> aspose.html.dom.Node:
|
5690
|
-
'''Returns a duplicate of
|
6028
|
+
'''Returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not.
|
5691
6029
|
|
5692
|
-
|
5693
|
-
:
|
6030
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners.
|
6031
|
+
It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener`
|
6032
|
+
or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
6033
|
+
|
6034
|
+
:param deep: If , then the node and its whole subtree, including text that may be in child :py:class:`aspose.html.dom.Text` nodes, is also copied.
|
6035
|
+
|
6036
|
+
If , only the node will be cloned. The subtree, including any text that the node contains, is not cloned.
|
6037
|
+
|
6038
|
+
Note that deep has no effect on empty elements, such as the and elements.
|
6039
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document,
|
6040
|
+
until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
5694
6041
|
...
|
5695
6042
|
|
5696
6043
|
def get_platform_type(self) -> Type:
|
5697
|
-
'''This method is used to retrieve ECMAScript object :py:class:`System.Type`.
|
6044
|
+
'''This method is used to retrieve the ECMAScript object :py:class:`System.Type`.
|
5698
6045
|
|
5699
|
-
:returns: The ECMAScript object
|
6046
|
+
:returns: The ECMAScript object.'''
|
5700
6047
|
...
|
5701
6048
|
|
5702
6049
|
def dispatch_event(self, event : aspose.html.dom.events.Event) -> bool:
|
5703
|
-
'''
|
6050
|
+
'''Dispatches an Event at the specified :py:class:`aspose.html.dom.events.IEventTarget`, (synchronously) invoking
|
6051
|
+
the affected EventListeners in the appropriate order.
|
6052
|
+
The normal event processing rules (including the capturing and optional bubbling phase) also apply to events
|
6053
|
+
dispatched manually with :py:func:`aspose.html.dom.events.IEventTarget.dispatch_event`.
|
5704
6054
|
|
5705
6055
|
:param event: Specifies the event type, behavior, and contextual information to be used in processing the event.
|
5706
6056
|
:returns: The return value of :py:func:`aspose.html.dom.EventTarget.dispatch_event` indicates whether any of the listeners which handled the event called :py:func:`aspose.html.dom.events.Event.prevent_default`.
|
@@ -5708,9 +6058,9 @@ class ShadowRoot(DocumentFragment):
|
|
5708
6058
|
...
|
5709
6059
|
|
5710
6060
|
def has_child_nodes(self) -> bool:
|
5711
|
-
'''Returns whether
|
6061
|
+
'''Returns a boolean value indicating whether the given :py:class:`aspose.html.dom.Node` has child nodes or not.
|
5712
6062
|
|
5713
|
-
:returns:
|
6063
|
+
:returns: A boolean value that is if the node has child nodes, and otherwise.'''
|
5714
6064
|
...
|
5715
6065
|
|
5716
6066
|
def normalize(self):
|
@@ -5726,11 +6076,10 @@ class ShadowRoot(DocumentFragment):
|
|
5726
6076
|
...
|
5727
6077
|
|
5728
6078
|
def is_same_node(self, other_node : aspose.html.dom.Node) -> bool:
|
5729
|
-
'''
|
5730
|
-
This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.
|
6079
|
+
'''Method is a legacy alias the for the strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object).
|
5731
6080
|
|
5732
|
-
:param other_node: The
|
5733
|
-
:returns:
|
6081
|
+
:param other_node: The Node to test against.
|
6082
|
+
:returns: A boolean value that is if both nodes are strictly equal, if not.'''
|
5734
6083
|
...
|
5735
6084
|
|
5736
6085
|
def lookup_prefix(self, namespace_uri : str) -> str:
|
@@ -5774,17 +6123,19 @@ class ShadowRoot(DocumentFragment):
|
|
5774
6123
|
...
|
5775
6124
|
|
5776
6125
|
def remove_child(self, child : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
5777
|
-
'''Removes
|
6126
|
+
'''Removes a child node from the DOM and returns the removed node.
|
5778
6127
|
|
5779
|
-
:param child:
|
5780
|
-
:returns:
|
6128
|
+
:param child: A :py:class:`aspose.html.dom.Node` that is the child node to be removed from the DOM.
|
6129
|
+
:returns: Unlike :py:func:`aspose.html.dom.Node.clone_node` the return value preserves the :py:class:`aspose.html.dom.events.IEventListener` objects associated with it.'''
|
5781
6130
|
...
|
5782
6131
|
|
5783
6132
|
def append_child(self, node : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
5784
|
-
'''Adds
|
6133
|
+
'''Adds a node to the end of the list of children of a specified parent node. If the given child is a reference to an existing node in the document, :py:func:`aspose.html.dom.Node.append_child` moves it from its current position to the new position (there is no requirement to remove the node from its parent node before appending it to some other node).
|
5785
6134
|
|
5786
|
-
|
5787
|
-
|
6135
|
+
This means that a node can't be in two points of the document simultaneously. So if the node already has a parent, the node is first removed, then appended at the new position. The :py:func:`aspose.html.dom.Node.clone_node` method can be used to make a copy of the node before appending it under the new parent. Copies made with :py:func:`aspose.html.dom.Node.clone_node` are not be automatically kept in sync.
|
6136
|
+
|
6137
|
+
:param node: The node to append to the given parent node (commonly an element).
|
6138
|
+
:returns: A Node that is the appended child, except when child is a :py:class:`aspose.html.dom.DocumentFragment`, in which case the empty :py:class:`aspose.html.dom.DocumentFragment` is returned.'''
|
5788
6139
|
...
|
5789
6140
|
|
5790
6141
|
def query_selector(self, selector : str) -> aspose.html.dom.Element:
|
@@ -5815,12 +6166,12 @@ class ShadowRoot(DocumentFragment):
|
|
5815
6166
|
|
5816
6167
|
@property
|
5817
6168
|
def prefix(self) -> str:
|
5818
|
-
'''
|
6169
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
5819
6170
|
...
|
5820
6171
|
|
5821
6172
|
@prefix.setter
|
5822
6173
|
def prefix(self, value : str):
|
5823
|
-
'''
|
6174
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
5824
6175
|
...
|
5825
6176
|
|
5826
6177
|
@property
|
@@ -6009,7 +6360,11 @@ class Text(CharacterData):
|
|
6009
6360
|
|
6010
6361
|
@overload
|
6011
6362
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener):
|
6012
|
-
'''
|
6363
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
6364
|
+
|
6365
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
6366
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
6367
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
6013
6368
|
|
6014
6369
|
:param type: The event type for which the user is registering
|
6015
6370
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.'''
|
@@ -6017,7 +6372,11 @@ class Text(CharacterData):
|
|
6017
6372
|
|
6018
6373
|
@overload
|
6019
6374
|
def add_event_listener(self, type : str, listener : aspose.html.dom.events.IEventListener, use_capture : bool):
|
6020
|
-
'''
|
6375
|
+
'''Sets up a function that will be called whenever the specified event is delivered to the target.
|
6376
|
+
|
6377
|
+
It works by adding a function, or an object that implements :py:class:`aspose.html.dom.events.IEventListener`,
|
6378
|
+
to the list of event listeners for the specified event type on the :py:class:`aspose.html.dom.EventTarget` on which it's called.
|
6379
|
+
If the function or object, is already in the list of event listeners for this target, they are not added a second time.
|
6021
6380
|
|
6022
6381
|
:param type: The event type for which the user is registering
|
6023
6382
|
:param listener: Takes an interface implemented by the user which contains the methods to be called when the event occurs.
|
@@ -6053,27 +6412,41 @@ class Text(CharacterData):
|
|
6053
6412
|
|
6054
6413
|
@overload
|
6055
6414
|
def clone_node(self) -> aspose.html.dom.Node:
|
6056
|
-
'''Returns a duplicate of
|
6415
|
+
'''Returns a duplicate of the node on which this method was called.
|
6057
6416
|
|
6058
|
-
:
|
6417
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners. It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener` or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
6418
|
+
|
6419
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document, until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
6059
6420
|
...
|
6060
6421
|
|
6061
6422
|
@overload
|
6062
6423
|
def clone_node(self, deep : bool) -> aspose.html.dom.Node:
|
6063
|
-
'''Returns a duplicate of
|
6424
|
+
'''Returns a duplicate of the node on which this method was called. Its parameter controls if the subtree contained in a node is also cloned or not.
|
6064
6425
|
|
6065
|
-
|
6066
|
-
:
|
6426
|
+
Cloning a node copies all of its attributes and their values, including intrinsic (inline) listeners.
|
6427
|
+
It does not copy event listeners added using :py:func:`aspose.html.dom.events.IEventTarget.add_event_listener`
|
6428
|
+
or those assigned to element properties (e.g., node.onclick = someFunction). Additionally, for a HTMLCanvasElement element, the painted image is not copied.
|
6429
|
+
|
6430
|
+
:param deep: If , then the node and its whole subtree, including text that may be in child :py:class:`aspose.html.dom.Text` nodes, is also copied.
|
6431
|
+
|
6432
|
+
If , only the node will be cloned. The subtree, including any text that the node contains, is not cloned.
|
6433
|
+
|
6434
|
+
Note that deep has no effect on empty elements, such as the and elements.
|
6435
|
+
:returns: The new :py:class:`aspose.html.dom.Node` cloned. The cloned node has no parent and is not part of the document,
|
6436
|
+
until it is added to another node that is part of the document, using :py:func:`aspose.html.dom.Node.append_child` or a similar method.'''
|
6067
6437
|
...
|
6068
6438
|
|
6069
6439
|
def get_platform_type(self) -> Type:
|
6070
|
-
'''This method is used to retrieve ECMAScript object :py:class:`System.Type`.
|
6440
|
+
'''This method is used to retrieve the ECMAScript object :py:class:`System.Type`.
|
6071
6441
|
|
6072
|
-
:returns: The ECMAScript object
|
6442
|
+
:returns: The ECMAScript object.'''
|
6073
6443
|
...
|
6074
6444
|
|
6075
6445
|
def dispatch_event(self, event : aspose.html.dom.events.Event) -> bool:
|
6076
|
-
'''
|
6446
|
+
'''Dispatches an Event at the specified :py:class:`aspose.html.dom.events.IEventTarget`, (synchronously) invoking
|
6447
|
+
the affected EventListeners in the appropriate order.
|
6448
|
+
The normal event processing rules (including the capturing and optional bubbling phase) also apply to events
|
6449
|
+
dispatched manually with :py:func:`aspose.html.dom.events.IEventTarget.dispatch_event`.
|
6077
6450
|
|
6078
6451
|
:param event: Specifies the event type, behavior, and contextual information to be used in processing the event.
|
6079
6452
|
:returns: The return value of :py:func:`aspose.html.dom.EventTarget.dispatch_event` indicates whether any of the listeners which handled the event called :py:func:`aspose.html.dom.events.Event.prevent_default`.
|
@@ -6081,9 +6454,9 @@ class Text(CharacterData):
|
|
6081
6454
|
...
|
6082
6455
|
|
6083
6456
|
def has_child_nodes(self) -> bool:
|
6084
|
-
'''Returns whether
|
6457
|
+
'''Returns a boolean value indicating whether the given :py:class:`aspose.html.dom.Node` has child nodes or not.
|
6085
6458
|
|
6086
|
-
:returns:
|
6459
|
+
:returns: A boolean value that is if the node has child nodes, and otherwise.'''
|
6087
6460
|
...
|
6088
6461
|
|
6089
6462
|
def normalize(self):
|
@@ -6099,11 +6472,10 @@ class Text(CharacterData):
|
|
6099
6472
|
...
|
6100
6473
|
|
6101
6474
|
def is_same_node(self, other_node : aspose.html.dom.Node) -> bool:
|
6102
|
-
'''
|
6103
|
-
This method provides a way to determine whether two Node references returned by the implementation reference the same object. When two Node references are references to the same object, even if through a proxy, the references may be used completely interchangeably, such that all attributes have the same values and calling the same DOM method on either reference always has exactly the same effect.
|
6475
|
+
'''Method is a legacy alias the for the strict equality operator. That is, it tests whether two nodes are the same (in other words, whether they reference the same object).
|
6104
6476
|
|
6105
|
-
:param other_node: The
|
6106
|
-
:returns:
|
6477
|
+
:param other_node: The Node to test against.
|
6478
|
+
:returns: A boolean value that is if both nodes are strictly equal, if not.'''
|
6107
6479
|
...
|
6108
6480
|
|
6109
6481
|
def lookup_prefix(self, namespace_uri : str) -> str:
|
@@ -6147,17 +6519,19 @@ class Text(CharacterData):
|
|
6147
6519
|
...
|
6148
6520
|
|
6149
6521
|
def remove_child(self, child : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
6150
|
-
'''Removes
|
6522
|
+
'''Removes a child node from the DOM and returns the removed node.
|
6151
6523
|
|
6152
|
-
:param child:
|
6153
|
-
:returns:
|
6524
|
+
:param child: A :py:class:`aspose.html.dom.Node` that is the child node to be removed from the DOM.
|
6525
|
+
:returns: Unlike :py:func:`aspose.html.dom.Node.clone_node` the return value preserves the :py:class:`aspose.html.dom.events.IEventListener` objects associated with it.'''
|
6154
6526
|
...
|
6155
6527
|
|
6156
6528
|
def append_child(self, node : aspose.html.dom.Node) -> aspose.html.dom.Node:
|
6157
|
-
'''Adds
|
6529
|
+
'''Adds a node to the end of the list of children of a specified parent node. If the given child is a reference to an existing node in the document, :py:func:`aspose.html.dom.Node.append_child` moves it from its current position to the new position (there is no requirement to remove the node from its parent node before appending it to some other node).
|
6158
6530
|
|
6159
|
-
|
6160
|
-
|
6531
|
+
This means that a node can't be in two points of the document simultaneously. So if the node already has a parent, the node is first removed, then appended at the new position. The :py:func:`aspose.html.dom.Node.clone_node` method can be used to make a copy of the node before appending it under the new parent. Copies made with :py:func:`aspose.html.dom.Node.clone_node` are not be automatically kept in sync.
|
6532
|
+
|
6533
|
+
:param node: The node to append to the given parent node (commonly an element).
|
6534
|
+
:returns: A Node that is the appended child, except when child is a :py:class:`aspose.html.dom.DocumentFragment`, in which case the empty :py:class:`aspose.html.dom.DocumentFragment` is returned.'''
|
6161
6535
|
...
|
6162
6536
|
|
6163
6537
|
def substring_data(self, offset : int, count : int) -> str:
|
@@ -6224,12 +6598,12 @@ class Text(CharacterData):
|
|
6224
6598
|
|
6225
6599
|
@property
|
6226
6600
|
def prefix(self) -> str:
|
6227
|
-
'''
|
6601
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
6228
6602
|
...
|
6229
6603
|
|
6230
6604
|
@prefix.setter
|
6231
6605
|
def prefix(self, value : str):
|
6232
|
-
'''
|
6606
|
+
'''Returns the namespace prefix of the specified element, or null if no prefix is specified.'''
|
6233
6607
|
...
|
6234
6608
|
|
6235
6609
|
@property
|
@@ -6389,9 +6763,9 @@ class TypeInfo(DOMObject):
|
|
6389
6763
|
'''The TypeInfo represents a type referenced from Element or Attr nodes, specified in the schemas associated with the document.'''
|
6390
6764
|
|
6391
6765
|
def get_platform_type(self) -> Type:
|
6392
|
-
'''This method is used to retrieve ECMAScript object :py:class:`System.Type`.
|
6766
|
+
'''This method is used to retrieve the ECMAScript object :py:class:`System.Type`.
|
6393
6767
|
|
6394
|
-
:returns: The ECMAScript object
|
6768
|
+
:returns: The ECMAScript object.'''
|
6395
6769
|
...
|
6396
6770
|
|
6397
6771
|
def is_derived_from(self, type_namespace_arg : str, type_name_arg : str, derivation_method : int) -> bool:
|