Module: IXMLDOMDocument

Includes:
WIN32OLE::VARIANT
Defined in:
sample/xml.rb

Constant Summary

Constants included from WIN32OLE::VARIANT

WIN32OLE::VARIANT::VT_ARRAY, WIN32OLE::VARIANT::VT_BOOL, WIN32OLE::VARIANT::VT_BSTR, WIN32OLE::VARIANT::VT_BYREF, WIN32OLE::VARIANT::VT_CY, WIN32OLE::VARIANT::VT_DATE, WIN32OLE::VARIANT::VT_DISPATCH, WIN32OLE::VARIANT::VT_EMPTY, WIN32OLE::VARIANT::VT_ERROR, WIN32OLE::VARIANT::VT_I1, WIN32OLE::VARIANT::VT_I2, WIN32OLE::VARIANT::VT_I4, WIN32OLE::VARIANT::VT_I8, WIN32OLE::VARIANT::VT_INT, WIN32OLE::VARIANT::VT_NULL, WIN32OLE::VARIANT::VT_PTR, WIN32OLE::VARIANT::VT_R4, WIN32OLE::VARIANT::VT_R8, WIN32OLE::VARIANT::VT_UI1, WIN32OLE::VARIANT::VT_UI2, WIN32OLE::VARIANT::VT_UI4, WIN32OLE::VARIANT::VT_UI8, WIN32OLE::VARIANT::VT_UINT, WIN32OLE::VARIANT::VT_UNKNOWN, WIN32OLE::VARIANT::VT_USERDEFINED, WIN32OLE::VARIANT::VT_VARIANT

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#lastargsObject (readonly)

Returns the value of attribute lastargs



471
472
473
# File 'sample/xml.rb', line 471

def lastargs
  @lastargs
end

Instance Method Details

#abortObject

VOID abort abort an asynchronous download



1019
1020
1021
1022
1023
# File 'sample/xml.rb', line 1019

def abort()
  ret = _invoke(62, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#appendChild(arg0) ⇒ Object

IXMLDOMNode appendChild append a child node

IXMLDOMNode arg0 --- newChild [IN]


849
850
851
852
853
# File 'sample/xml.rb', line 849

def appendChild(arg0)
  ret = _invoke(16, [arg0], [VT_BYREF|VT_DISPATCH])
  @lastargs = WIN32OLE::ARGV
  ret
end

#asyncObject

BOOL async flag for asynchronous download



699
700
701
702
703
# File 'sample/xml.rb', line 699

def async()
  ret = _getproperty(61, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#async=(arg0) ⇒ Object

VOID async flag for asynchronous download



763
764
765
766
767
# File 'sample/xml.rb', line 763

def async=(arg0)
  ret = _setproperty(61, [arg0], [VT_BOOL])
  @lastargs = WIN32OLE::ARGV
  ret
end

#attributesObject

IXMLDOMNamedNodeMap attributes the collection of the node's attributes



547
548
549
550
551
# File 'sample/xml.rb', line 547

def attributes()
  ret = _getproperty(12, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#baseNameObject

BSTR baseName the base name of the node (nodename with the prefix stripped off)



643
644
645
646
647
# File 'sample/xml.rb', line 643

def baseName()
  ret = _getproperty(34, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#childNodesObject

IXMLDOMNodeList childNodes the collection of the node's children



507
508
509
510
511
# File 'sample/xml.rb', line 507

def childNodes()
  ret = _getproperty(7, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#cloneNode(arg0) ⇒ Object

IXMLDOMNode cloneNode

BOOL arg0 --- deep [IN]


864
865
866
867
868
# File 'sample/xml.rb', line 864

def cloneNode(arg0)
  ret = _invoke(19, [arg0], [VT_BOOL])
  @lastargs = WIN32OLE::ARGV
  ret
end

#createAttribute(arg0) ⇒ Object

IXMLDOMAttribute createAttribute create an attribute node

BSTR arg0 --- name [IN]


964
965
966
967
968
# File 'sample/xml.rb', line 964

def createAttribute(arg0)
  ret = _invoke(47, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end

#createCDATASection(arg0) ⇒ Object

IXMLDOMCDATASection createCDATASection create a CDATA section node

BSTR arg0 --- data [IN]


945
946
947
948
949
# File 'sample/xml.rb', line 945

def createCDATASection(arg0)
  ret = _invoke(45, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end

#createComment(arg0) ⇒ Object

IXMLDOMComment createComment create a comment node

BSTR arg0 --- data [IN]


936
937
938
939
940
# File 'sample/xml.rb', line 936

def createComment(arg0)
  ret = _invoke(44, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end

#createDocumentFragmentObject

IXMLDOMDocumentFragment createDocumentFragment create a DocumentFragment node



918
919
920
921
922
# File 'sample/xml.rb', line 918

def createDocumentFragment()
  ret = _invoke(42, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#createElement(arg0) ⇒ Object

IXMLDOMElement createElement create an Element node

BSTR arg0 --- tagName [IN]


910
911
912
913
914
# File 'sample/xml.rb', line 910

def createElement(arg0)
  ret = _invoke(41, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end

#createEntityReference(arg0) ⇒ Object

IXMLDOMEntityReference createEntityReference create an entity reference node

BSTR arg0 --- name [IN]


973
974
975
976
977
# File 'sample/xml.rb', line 973

def createEntityReference(arg0)
  ret = _invoke(49, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end

#createNode(arg0, arg1, arg2) ⇒ Object

IXMLDOMNode createNode create a node of the specified node type and name

VARIANT arg0 --- type [IN]
BSTR arg1 --- name [IN]
BSTR arg2 --- namespaceURI [IN]


993
994
995
996
997
# File 'sample/xml.rb', line 993

def createNode(arg0, arg1, arg2)
  ret = _invoke(54, [arg0, arg1, arg2], [VT_VARIANT, VT_BSTR, VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end

#createProcessingInstruction(arg0, arg1) ⇒ Object

IXMLDOMProcessingInstruction createProcessingInstruction create a processing instruction node

BSTR arg0 --- target [IN]
BSTR arg1 --- data [IN]


955
956
957
958
959
# File 'sample/xml.rb', line 955

def createProcessingInstruction(arg0, arg1)
  ret = _invoke(46, [arg0, arg1], [VT_BSTR, VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end

#createTextNode(arg0) ⇒ Object

IXMLDOMText createTextNode create a text node

BSTR arg0 --- data [IN]


927
928
929
930
931
# File 'sample/xml.rb', line 927

def createTextNode(arg0)
  ret = _invoke(43, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end

#dataTypeObject

VARIANT dataType the data type of the node



603
604
605
606
607
# File 'sample/xml.rb', line 603

def dataType()
  ret = _getproperty(26, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#dataType=(arg0) ⇒ Object

VOID dataType the data type of the node



755
756
757
758
759
# File 'sample/xml.rb', line 755

def dataType=(arg0)
  ret = _setproperty(26, [arg0], [VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end

#definitionObject

IXMLDOMNode definition pointer to the definition of the node in the DTD or schema



587
588
589
590
591
# File 'sample/xml.rb', line 587

def definition()
  ret = _getproperty(23, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#doctypeObject

IXMLDOMDocumentType doctype node corresponding to the DOCTYPE



651
652
653
654
655
# File 'sample/xml.rb', line 651

def doctype()
  ret = _getproperty(38, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#documentElementObject

IXMLDOMElement documentElement the root of the tree



667
668
669
670
671
# File 'sample/xml.rb', line 667

def documentElement()
  ret = _getproperty(40, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#firstChildObject

IXMLDOMNode firstChild first child of the node



515
516
517
518
519
# File 'sample/xml.rb', line 515

def firstChild()
  ret = _getproperty(8, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#getElementsByTagName(arg0) ⇒ Object

IXMLDOMNodeList getElementsByTagName build a list of elements by name

BSTR arg0 --- tagName [IN]


982
983
984
985
986
# File 'sample/xml.rb', line 982

def getElementsByTagName(arg0)
  ret = _invoke(50, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end

#hasChildNodesObject

BOOL hasChildNodes



856
857
858
859
860
# File 'sample/xml.rb', line 856

def hasChildNodes()
  ret = _invoke(17, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#implementationObject

IXMLDOMImplementation implementation info on this DOM implementation



659
660
661
662
663
# File 'sample/xml.rb', line 659

def implementation()
  ret = _getproperty(39, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#insertBefore(arg0, arg1) ⇒ Object

IXMLDOMNode insertBefore insert a child node

IXMLDOMNode arg0 --- newChild [IN]
VARIANT arg1 --- refChild [IN]


821
822
823
824
825
# File 'sample/xml.rb', line 821

def insertBefore(arg0, arg1)
  ret = _invoke(13, [arg0, arg1], [VT_BYREF|VT_DISPATCH, VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end

#lastChildObject

IXMLDOMNode lastChild first child of the node



523
524
525
526
527
# File 'sample/xml.rb', line 523

def lastChild()
  ret = _getproperty(9, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#load(arg0) ⇒ Object

BOOL load load document from the specified XML source

VARIANT arg0 --- xmlSource [IN]


1011
1012
1013
1014
1015
# File 'sample/xml.rb', line 1011

def load(arg0)
  ret = _invoke(58, [arg0], [VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end

#loadXML(arg0) ⇒ Object

BOOL loadXML load the document from a string

BSTR arg0 --- bstrXML [IN]


1028
1029
1030
1031
1032
# File 'sample/xml.rb', line 1028

def loadXML(arg0)
  ret = _invoke(63, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end

#namespaceURIObject

BSTR namespaceURI the URI for the namespace applying to the node



627
628
629
630
631
# File 'sample/xml.rb', line 627

def namespaceURI()
  ret = _getproperty(32, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#nextSiblingObject

IXMLDOMNode nextSibling right sibling of the node



539
540
541
542
543
# File 'sample/xml.rb', line 539

def nextSibling()
  ret = _getproperty(11, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#nodeFromID(arg0) ⇒ Object

IXMLDOMNode nodeFromID retrieve node from it's ID

BSTR arg0 --- idString [IN]


1002
1003
1004
1005
1006
# File 'sample/xml.rb', line 1002

def nodeFromID(arg0)
  ret = _invoke(56, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end

#nodeNameObject

BSTR nodeName name of the node



475
476
477
478
479
# File 'sample/xml.rb', line 475

def nodeName()
  ret = _getproperty(2, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#nodeTypeObject

DOMNodeType nodeType the node's type



491
492
493
494
495
# File 'sample/xml.rb', line 491

def nodeType()
  ret = _getproperty(4, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#nodeTypedValueObject

VARIANT nodeTypedValue get the strongly typed value of the node



595
596
597
598
599
# File 'sample/xml.rb', line 595

def nodeTypedValue()
  ret = _getproperty(25, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#nodeTypedValue=(arg0) ⇒ Object

VOID nodeTypedValue get the strongly typed value of the node



747
748
749
750
751
# File 'sample/xml.rb', line 747

def nodeTypedValue=(arg0)
  ret = _setproperty(25, [arg0], [VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end

#nodeTypeStringObject

BSTR nodeTypeString the type of node in string form



563
564
565
566
567
# File 'sample/xml.rb', line 563

def nodeTypeString()
  ret = _getproperty(21, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#nodeValueObject

VARIANT nodeValue value stored in the node



483
484
485
486
487
# File 'sample/xml.rb', line 483

def nodeValue()
  ret = _getproperty(3, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#nodeValue=(arg0) ⇒ Object

VOID nodeValue value stored in the node



731
732
733
734
735
# File 'sample/xml.rb', line 731

def nodeValue=(arg0)
  ret = _setproperty(3, [arg0], [VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end

#ondataavailable=(arg0) ⇒ Object

VOID ondataavailable register an ondataavailable event handler



803
804
805
806
807
# File 'sample/xml.rb', line 803

def ondataavailable=(arg0)
  ret = _setproperty(69, [arg0], [VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end

#onreadystatechange=(arg0) ⇒ Object

VOID onreadystatechange register a readystatechange event handler



795
796
797
798
799
# File 'sample/xml.rb', line 795

def onreadystatechange=(arg0)
  ret = _setproperty(68, [arg0], [VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end

#ontransformnode=(arg0) ⇒ Object

VOID ontransformnode register an ontransformnode event handler



811
812
813
814
815
# File 'sample/xml.rb', line 811

def ontransformnode=(arg0)
  ret = _setproperty(70, [arg0], [VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end

#ownerDocumentObject

IXMLDOMDocument ownerDocument document that contains the node



555
556
557
558
559
# File 'sample/xml.rb', line 555

def ownerDocument()
  ret = _getproperty(18, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#parentNodeObject

IXMLDOMNode parentNode parent of the node



499
500
501
502
503
# File 'sample/xml.rb', line 499

def parentNode()
  ret = _getproperty(6, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#parsedObject

BOOL parsed has sub-tree been completely parsed



619
620
621
622
623
# File 'sample/xml.rb', line 619

def parsed()
  ret = _getproperty(31, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#parseErrorObject

IXMLDOMParseError parseError get the last parser error



683
684
685
686
687
# File 'sample/xml.rb', line 683

def parseError()
  ret = _getproperty(59, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#prefixObject

BSTR prefix the prefix for the namespace applying to the node



635
636
637
638
639
# File 'sample/xml.rb', line 635

def prefix()
  ret = _getproperty(33, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#preserveWhiteSpaceObject

BOOL preserveWhiteSpace indicates whether the parser preserves whitespace



723
724
725
726
727
# File 'sample/xml.rb', line 723

def preserveWhiteSpace()
  ret = _getproperty(67, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#preserveWhiteSpace=(arg0) ⇒ Object

VOID preserveWhiteSpace indicates whether the parser preserves whitespace



787
788
789
790
791
# File 'sample/xml.rb', line 787

def preserveWhiteSpace=(arg0)
  ret = _setproperty(67, [arg0], [VT_BOOL])
  @lastargs = WIN32OLE::ARGV
  ret
end

#previousSiblingObject

IXMLDOMNode previousSibling left sibling of the node



531
532
533
534
535
# File 'sample/xml.rb', line 531

def previousSibling()
  ret = _getproperty(10, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#readyStateObject

I4 readyState get the state of the XML document



675
676
677
678
679
# File 'sample/xml.rb', line 675

def readyState()
  ret = _getproperty(-525, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#removeChild(arg0) ⇒ Object

IXMLDOMNode removeChild remove a child node

IXMLDOMNode arg0 --- childNode [IN]


840
841
842
843
844
# File 'sample/xml.rb', line 840

def removeChild(arg0)
  ret = _invoke(15, [arg0], [VT_BYREF|VT_DISPATCH])
  @lastargs = WIN32OLE::ARGV
  ret
end

#replaceChild(arg0, arg1) ⇒ Object

IXMLDOMNode replaceChild replace a child node

IXMLDOMNode arg0 --- newChild [IN]
IXMLDOMNode arg1 --- oldChild [IN]


831
832
833
834
835
# File 'sample/xml.rb', line 831

def replaceChild(arg0, arg1)
  ret = _invoke(14, [arg0, arg1], [VT_BYREF|VT_DISPATCH, VT_BYREF|VT_DISPATCH])
  @lastargs = WIN32OLE::ARGV
  ret
end

#resolveExternalsObject

BOOL resolveExternals indicates whether the parser resolves references to external DTD/Entities/Schema



715
716
717
718
719
# File 'sample/xml.rb', line 715

def resolveExternals()
  ret = _getproperty(66, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#resolveExternals=(arg0) ⇒ Object

VOID resolveExternals indicates whether the parser resolves references to external DTD/Entities/Schema



779
780
781
782
783
# File 'sample/xml.rb', line 779

def resolveExternals=(arg0)
  ret = _setproperty(66, [arg0], [VT_BOOL])
  @lastargs = WIN32OLE::ARGV
  ret
end

#save(arg0) ⇒ Object

VOID save save the document to a specified desination

VARIANT arg0 --- desination [IN]


1037
1038
1039
1040
1041
# File 'sample/xml.rb', line 1037

def save(arg0)
  ret = _invoke(64, [arg0], [VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end

#selectNodes(arg0) ⇒ Object

IXMLDOMNodeList selectNodes execute query on the subtree

BSTR arg0 --- queryString [IN]


882
883
884
885
886
# File 'sample/xml.rb', line 882

def selectNodes(arg0)
  ret = _invoke(29, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end

#selectSingleNode(arg0) ⇒ Object

IXMLDOMNode selectSingleNode execute query on the subtree

BSTR arg0 --- queryString [IN]


891
892
893
894
895
# File 'sample/xml.rb', line 891

def selectSingleNode(arg0)
  ret = _invoke(30, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end

#specifiedObject

BOOL specified indicates whether node is a default value



579
580
581
582
583
# File 'sample/xml.rb', line 579

def specified()
  ret = _getproperty(22, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#textObject

BSTR text text content of the node and subtree



571
572
573
574
575
# File 'sample/xml.rb', line 571

def text()
  ret = _getproperty(24, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#text=(arg0) ⇒ Object

VOID text text content of the node and subtree



739
740
741
742
743
# File 'sample/xml.rb', line 739

def text=(arg0)
  ret = _setproperty(24, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end

#transformNode(arg0) ⇒ Object

BSTR transformNode apply the stylesheet to the subtree

IXMLDOMNode arg0 --- stylesheet [IN]


873
874
875
876
877
# File 'sample/xml.rb', line 873

def transformNode(arg0)
  ret = _invoke(28, [arg0], [VT_BYREF|VT_DISPATCH])
  @lastargs = WIN32OLE::ARGV
  ret
end

#transformNodeToObject(arg0, arg1) ⇒ Object

VOID transformNodeToObject apply the stylesheet to the subtree, returning the result through a document or a stream

IXMLDOMNode arg0 --- stylesheet [IN]
VARIANT arg1 --- outputObject [IN]


901
902
903
904
905
# File 'sample/xml.rb', line 901

def transformNodeToObject(arg0, arg1)
  ret = _invoke(35, [arg0, arg1], [VT_BYREF|VT_DISPATCH, VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end

#urlObject

BSTR url get the URL for the loaded XML document



691
692
693
694
695
# File 'sample/xml.rb', line 691

def url()
  ret = _getproperty(60, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#validateOnParseObject

BOOL validateOnParse indicates whether the parser performs validation



707
708
709
710
711
# File 'sample/xml.rb', line 707

def validateOnParse()
  ret = _getproperty(65, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end

#validateOnParse=(arg0) ⇒ Object

VOID validateOnParse indicates whether the parser performs validation



771
772
773
774
775
# File 'sample/xml.rb', line 771

def validateOnParse=(arg0)
  ret = _setproperty(65, [arg0], [VT_BOOL])
  @lastargs = WIN32OLE::ARGV
  ret
end

#xmlObject

BSTR xml return the XML source for the node and each of its descendants



611
612
613
614
615
# File 'sample/xml.rb', line 611

def xml()
  ret = _getproperty(27, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end