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


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

def lastargs
  @lastargs
end

Instance Method Details

#abortObject

VOID abort abort an asynchronous download


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

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

#appendChild(arg0) ⇒ Object

IXMLDOMNode appendChild append a child node

IXMLDOMNode arg0 --- newChild [IN]

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

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

#asyncObject

BOOL async flag for asynchronous download


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

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

#async=(arg0) ⇒ Object

VOID async flag for asynchronous download


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

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

#attributesObject

IXMLDOMNamedNodeMap attributes the collection of the node's attributes


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

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)


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

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

#childNodesObject

IXMLDOMNodeList childNodes the collection of the node's children


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

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

#cloneNode(arg0) ⇒ Object

IXMLDOMNode cloneNode

BOOL arg0 --- deep [IN]

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

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]

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

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]

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

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]

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

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

#createDocumentFragmentObject

IXMLDOMDocumentFragment createDocumentFragment create a DocumentFragment node


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

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

#createElement(arg0) ⇒ Object

IXMLDOMElement createElement create an Element node

BSTR arg0 --- tagName [IN]

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

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]

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

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]

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

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]

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

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]

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

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

#dataTypeObject

VARIANT dataType the data type of the node


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

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

#dataType=(arg0) ⇒ Object

VOID dataType the data type of the node


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

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


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

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

#doctypeObject

IXMLDOMDocumentType doctype node corresponding to the DOCTYPE


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

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

#documentElementObject

IXMLDOMElement documentElement the root of the tree


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

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

#firstChildObject

IXMLDOMNode firstChild first child of the node


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

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]

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

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

#hasChildNodesObject

BOOL hasChildNodes


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

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

#implementationObject

IXMLDOMImplementation implementation info on this DOM implementation


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

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]

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

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


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

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]

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

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]

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

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


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

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

#nextSiblingObject

IXMLDOMNode nextSibling right sibling of the node


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

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]

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

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

#nodeNameObject

BSTR nodeName name of the node


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

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

#nodeTypeObject

DOMNodeType nodeType the node's type


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

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

#nodeTypedValueObject

VARIANT nodeTypedValue get the strongly typed value of the node


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

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

#nodeTypedValue=(arg0) ⇒ Object

VOID nodeTypedValue get the strongly typed value of the node


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

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

#nodeTypeStringObject

BSTR nodeTypeString the type of node in string form


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

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

#nodeValueObject

VARIANT nodeValue value stored in the node


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

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

#nodeValue=(arg0) ⇒ Object

VOID nodeValue value stored in the node


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

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

#ondataavailable=(arg0) ⇒ Object

VOID ondataavailable register an ondataavailable event handler


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

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

#onreadystatechange=(arg0) ⇒ Object

VOID onreadystatechange register a readystatechange event handler


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

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

#ontransformnode=(arg0) ⇒ Object

VOID ontransformnode register an ontransformnode event handler


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

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

#ownerDocumentObject

IXMLDOMDocument ownerDocument document that contains the node


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

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

#parentNodeObject

IXMLDOMNode parentNode parent of the node


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

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

#parsedObject

BOOL parsed has sub-tree been completely parsed


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

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

#parseErrorObject

IXMLDOMParseError parseError get the last parser error


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

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

#prefixObject

BSTR prefix the prefix for the namespace applying to the node


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

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

#preserveWhiteSpaceObject

BOOL preserveWhiteSpace indicates whether the parser preserves whitespace


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

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

#preserveWhiteSpace=(arg0) ⇒ Object

VOID preserveWhiteSpace indicates whether the parser preserves whitespace


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

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

#previousSiblingObject

IXMLDOMNode previousSibling left sibling of the node


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

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

#readyStateObject

I4 readyState get the state of the XML document


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

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

#removeChild(arg0) ⇒ Object

IXMLDOMNode removeChild remove a child node

IXMLDOMNode arg0 --- childNode [IN]

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

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]

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

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


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

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


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

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]

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

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]

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

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]

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

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

#specifiedObject

BOOL specified indicates whether node is a default value


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

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

#textObject

BSTR text text content of the node and subtree


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

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

#text=(arg0) ⇒ Object

VOID text text content of the node and subtree


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

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]

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

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]

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

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


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

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

#validateOnParseObject

BOOL validateOnParse indicates whether the parser performs validation


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

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

#validateOnParse=(arg0) ⇒ Object

VOID validateOnParse indicates whether the parser performs validation


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

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


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

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