W3C-DOM XML Document (Apartment)

Methods
A
B
C
D
F
G
H
I
L
M
N
O
P
R
S
T
U
V
X
Included Modules
Attributes
[R] clsid
[R] dispatch
[R] lastargs
[R] progid
Class Public methods
new(obj = nil)
# File ext/win32ole/sample/xml.rb, line 6257
def initialize(obj = nil)
  @clsid = "{2933BF91-7B36-11D2-B20E-00C04F983E60}"
  @progid = "Microsoft.FreeThreadedXMLDOM.1.0"
  if obj.nil?
    @dispatch = WIN32OLE.new(@progid)
  else
    @dispatch = obj
  end
end
Instance Public methods
abort()

VOID abort abort an asynchronous download

# File ext/win32ole/sample/xml.rb, line 6817
def abort()
  ret = @dispatch._invoke(62, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
appendChild(arg0)

IXMLDOMNode appendChild append a child node

IXMLDOMNode arg0 --- newChild [IN]
# File ext/win32ole/sample/xml.rb, line 6647
def appendChild(arg0)
  ret = @dispatch._invoke(16, [arg0], [VT_BYREF|VT_DISPATCH])
  @lastargs = WIN32OLE::ARGV
  ret
end
async()

BOOL async flag for asynchronous download

# File ext/win32ole/sample/xml.rb, line 6497
def async()
  ret = @dispatch._getproperty(61, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
async=(arg0)

VOID async flag for asynchronous download

# File ext/win32ole/sample/xml.rb, line 6561
def async=(arg0)
  ret = @dispatch._setproperty(61, [arg0], [VT_BOOL])
  @lastargs = WIN32OLE::ARGV
  ret
end
attributes()

IXMLDOMNamedNodeMap attributes the collection of the node's attributes

# File ext/win32ole/sample/xml.rb, line 6345
def attributes()
  ret = @dispatch._getproperty(12, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
baseName()

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

# File ext/win32ole/sample/xml.rb, line 6441
def baseName()
  ret = @dispatch._getproperty(34, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
childNodes()

IXMLDOMNodeList childNodes the collection of the node's children

# File ext/win32ole/sample/xml.rb, line 6305
def childNodes()
  ret = @dispatch._getproperty(7, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
cloneNode(arg0)

IXMLDOMNode cloneNode

BOOL arg0 --- deep [IN]
# File ext/win32ole/sample/xml.rb, line 6662
def cloneNode(arg0)
  ret = @dispatch._invoke(19, [arg0], [VT_BOOL])
  @lastargs = WIN32OLE::ARGV
  ret
end
createAttribute(arg0)

IXMLDOMAttribute createAttribute create an attribute node

BSTR arg0 --- name [IN]
# File ext/win32ole/sample/xml.rb, line 6762
def createAttribute(arg0)
  ret = @dispatch._invoke(47, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end
createCDATASection(arg0)

IXMLDOMCDATASection createCDATASection create a CDATA section node

BSTR arg0 --- data [IN]
# File ext/win32ole/sample/xml.rb, line 6743
def createCDATASection(arg0)
  ret = @dispatch._invoke(45, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end
createComment(arg0)

IXMLDOMComment createComment create a comment node

BSTR arg0 --- data [IN]
# File ext/win32ole/sample/xml.rb, line 6734
def createComment(arg0)
  ret = @dispatch._invoke(44, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end
createDocumentFragment()

IXMLDOMDocumentFragment createDocumentFragment create a DocumentFragment node

# File ext/win32ole/sample/xml.rb, line 6716
def createDocumentFragment()
  ret = @dispatch._invoke(42, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
createElement(arg0)

IXMLDOMElement createElement create an Element node

BSTR arg0 --- tagName [IN]
# File ext/win32ole/sample/xml.rb, line 6708
def createElement(arg0)
  ret = @dispatch._invoke(41, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end
createEntityReference(arg0)

IXMLDOMEntityReference createEntityReference create an entity reference node

BSTR arg0 --- name [IN]
# File ext/win32ole/sample/xml.rb, line 6771
def createEntityReference(arg0)
  ret = @dispatch._invoke(49, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end
createNode(arg0, arg1, arg2)

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

VARIANT arg0 --- type [IN]
BSTR arg1 --- name [IN]
BSTR arg2 --- namespaceURI [IN]
# File ext/win32ole/sample/xml.rb, line 6791
def createNode(arg0, arg1, arg2)
  ret = @dispatch._invoke(54, [arg0, arg1, arg2], [VT_VARIANT, VT_BSTR, VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end
createProcessingInstruction(arg0, arg1)

IXMLDOMProcessingInstruction createProcessingInstruction create a processing instruction node

BSTR arg0 --- target [IN]
BSTR arg1 --- data [IN]
# File ext/win32ole/sample/xml.rb, line 6753
def createProcessingInstruction(arg0, arg1)
  ret = @dispatch._invoke(46, [arg0, arg1], [VT_BSTR, VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end
createTextNode(arg0)

IXMLDOMText createTextNode create a text node

BSTR arg0 --- data [IN]
# File ext/win32ole/sample/xml.rb, line 6725
def createTextNode(arg0)
  ret = @dispatch._invoke(43, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end
dataType()

VARIANT dataType the data type of the node

# File ext/win32ole/sample/xml.rb, line 6401
def dataType()
  ret = @dispatch._getproperty(26, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
dataType=(arg0)

VOID dataType the data type of the node

# File ext/win32ole/sample/xml.rb, line 6553
def dataType=(arg0)
  ret = @dispatch._setproperty(26, [arg0], [VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end
definition()

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

# File ext/win32ole/sample/xml.rb, line 6385
def definition()
  ret = @dispatch._getproperty(23, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
doctype()

IXMLDOMDocumentType doctype node corresponding to the DOCTYPE

# File ext/win32ole/sample/xml.rb, line 6449
def doctype()
  ret = @dispatch._getproperty(38, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
documentElement()

IXMLDOMElement documentElement the root of the tree

# File ext/win32ole/sample/xml.rb, line 6465
def documentElement()
  ret = @dispatch._getproperty(40, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
firstChild()

IXMLDOMNode firstChild first child of the node

# File ext/win32ole/sample/xml.rb, line 6313
def firstChild()
  ret = @dispatch._getproperty(8, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
getElementsByTagName(arg0)

IXMLDOMNodeList getElementsByTagName build a list of elements by name

BSTR arg0 --- tagName [IN]
# File ext/win32ole/sample/xml.rb, line 6780
def getElementsByTagName(arg0)
  ret = @dispatch._invoke(50, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end
hasChildNodes()

BOOL hasChildNodes

# File ext/win32ole/sample/xml.rb, line 6654
def hasChildNodes()
  ret = @dispatch._invoke(17, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
implementation()

IXMLDOMImplementation implementation info on this DOM implementation

# File ext/win32ole/sample/xml.rb, line 6457
def implementation()
  ret = @dispatch._getproperty(39, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
insertBefore(arg0, arg1)

IXMLDOMNode insertBefore insert a child node

IXMLDOMNode arg0 --- newChild [IN]
VARIANT arg1 --- refChild [IN]
# File ext/win32ole/sample/xml.rb, line 6619
def insertBefore(arg0, arg1)
  ret = @dispatch._invoke(13, [arg0, arg1], [VT_BYREF|VT_DISPATCH, VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end
lastChild()

IXMLDOMNode lastChild first child of the node

# File ext/win32ole/sample/xml.rb, line 6321
def lastChild()
  ret = @dispatch._getproperty(9, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
load(arg0)

BOOL load load document from the specified XML source

VARIANT arg0 --- xmlSource [IN]
# File ext/win32ole/sample/xml.rb, line 6809
def load(arg0)
  ret = @dispatch._invoke(58, [arg0], [VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end
loadXML(arg0)

BOOL loadXML load the document from a string

BSTR arg0 --- bstrXML [IN]
# File ext/win32ole/sample/xml.rb, line 6826
def loadXML(arg0)
  ret = @dispatch._invoke(63, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end
method_missing(cmd, *arg)
# File ext/win32ole/sample/xml.rb, line 6267
def method_missing(cmd, *arg)
  @dispatch.method_missing(cmd, *arg)
end
namespaceURI()

BSTR namespaceURI the URI for the namespace applying to the node

# File ext/win32ole/sample/xml.rb, line 6425
def namespaceURI()
  ret = @dispatch._getproperty(32, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
nextSibling()

IXMLDOMNode nextSibling right sibling of the node

# File ext/win32ole/sample/xml.rb, line 6337
def nextSibling()
  ret = @dispatch._getproperty(11, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
nodeFromID(arg0)

IXMLDOMNode nodeFromID retrieve node from it's ID

BSTR arg0 --- idString [IN]
# File ext/win32ole/sample/xml.rb, line 6800
def nodeFromID(arg0)
  ret = @dispatch._invoke(56, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end
nodeName()

BSTR nodeName name of the node

# File ext/win32ole/sample/xml.rb, line 6273
def nodeName()
  ret = @dispatch._getproperty(2, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
nodeType()

DOMNodeType nodeType the node's type

# File ext/win32ole/sample/xml.rb, line 6289
def nodeType()
  ret = @dispatch._getproperty(4, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
nodeTypeString()

BSTR nodeTypeString the type of node in string form

# File ext/win32ole/sample/xml.rb, line 6361
def nodeTypeString()
  ret = @dispatch._getproperty(21, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
nodeTypedValue()

VARIANT nodeTypedValue get the strongly typed value of the node

# File ext/win32ole/sample/xml.rb, line 6393
def nodeTypedValue()
  ret = @dispatch._getproperty(25, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
nodeTypedValue=(arg0)

VOID nodeTypedValue get the strongly typed value of the node

# File ext/win32ole/sample/xml.rb, line 6545
def nodeTypedValue=(arg0)
  ret = @dispatch._setproperty(25, [arg0], [VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end
nodeValue()

VARIANT nodeValue value stored in the node

# File ext/win32ole/sample/xml.rb, line 6281
def nodeValue()
  ret = @dispatch._getproperty(3, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
nodeValue=(arg0)

VOID nodeValue value stored in the node

# File ext/win32ole/sample/xml.rb, line 6529
def nodeValue=(arg0)
  ret = @dispatch._setproperty(3, [arg0], [VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end
ondataavailable()

HRESULT ondataavailable EVENT in XMLDOMDocumentEvents

# File ext/win32ole/sample/xml.rb, line 6842
def ondataavailable()
  ret = @dispatch._invoke(198, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
ondataavailable=(arg0)

VOID ondataavailable register an ondataavailable event handler

# File ext/win32ole/sample/xml.rb, line 6601
def ondataavailable=(arg0)
  ret = @dispatch._setproperty(69, [arg0], [VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end
onreadystatechange()

HRESULT onreadystatechange EVENT in XMLDOMDocumentEvents

# File ext/win32ole/sample/xml.rb, line 6849
def onreadystatechange()
  ret = @dispatch._invoke(-609, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
onreadystatechange=(arg0)

VOID onreadystatechange register a readystatechange event handler

# File ext/win32ole/sample/xml.rb, line 6593
def onreadystatechange=(arg0)
  ret = @dispatch._setproperty(68, [arg0], [VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end
ontransformnode=(arg0)

VOID ontransformnode register an ontransformnode event handler

# File ext/win32ole/sample/xml.rb, line 6609
def ontransformnode=(arg0)
  ret = @dispatch._setproperty(70, [arg0], [VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end
ownerDocument()

IXMLDOMDocument ownerDocument document that contains the node

# File ext/win32ole/sample/xml.rb, line 6353
def ownerDocument()
  ret = @dispatch._getproperty(18, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
parentNode()

IXMLDOMNode parentNode parent of the node

# File ext/win32ole/sample/xml.rb, line 6297
def parentNode()
  ret = @dispatch._getproperty(6, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
parseError()

IXMLDOMParseError parseError get the last parser error

# File ext/win32ole/sample/xml.rb, line 6481
def parseError()
  ret = @dispatch._getproperty(59, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
parsed()

BOOL parsed has sub-tree been completely parsed

# File ext/win32ole/sample/xml.rb, line 6417
def parsed()
  ret = @dispatch._getproperty(31, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
prefix()

BSTR prefix the prefix for the namespace applying to the node

# File ext/win32ole/sample/xml.rb, line 6433
def prefix()
  ret = @dispatch._getproperty(33, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
preserveWhiteSpace()

BOOL preserveWhiteSpace indicates whether the parser preserves whitespace

# File ext/win32ole/sample/xml.rb, line 6521
def preserveWhiteSpace()
  ret = @dispatch._getproperty(67, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
preserveWhiteSpace=(arg0)

VOID preserveWhiteSpace indicates whether the parser preserves whitespace

# File ext/win32ole/sample/xml.rb, line 6585
def preserveWhiteSpace=(arg0)
  ret = @dispatch._setproperty(67, [arg0], [VT_BOOL])
  @lastargs = WIN32OLE::ARGV
  ret
end
previousSibling()

IXMLDOMNode previousSibling left sibling of the node

# File ext/win32ole/sample/xml.rb, line 6329
def previousSibling()
  ret = @dispatch._getproperty(10, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
readyState()

I4 readyState get the state of the XML document

# File ext/win32ole/sample/xml.rb, line 6473
def readyState()
  ret = @dispatch._getproperty(-525, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
removeChild(arg0)

IXMLDOMNode removeChild remove a child node

IXMLDOMNode arg0 --- childNode [IN]
# File ext/win32ole/sample/xml.rb, line 6638
def removeChild(arg0)
  ret = @dispatch._invoke(15, [arg0], [VT_BYREF|VT_DISPATCH])
  @lastargs = WIN32OLE::ARGV
  ret
end
replaceChild(arg0, arg1)

IXMLDOMNode replaceChild replace a child node

IXMLDOMNode arg0 --- newChild [IN]
IXMLDOMNode arg1 --- oldChild [IN]
# File ext/win32ole/sample/xml.rb, line 6629
def replaceChild(arg0, arg1)
  ret = @dispatch._invoke(14, [arg0, arg1], [VT_BYREF|VT_DISPATCH, VT_BYREF|VT_DISPATCH])
  @lastargs = WIN32OLE::ARGV
  ret
end
resolveExternals()

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

# File ext/win32ole/sample/xml.rb, line 6513
def resolveExternals()
  ret = @dispatch._getproperty(66, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
resolveExternals=(arg0)

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

# File ext/win32ole/sample/xml.rb, line 6577
def resolveExternals=(arg0)
  ret = @dispatch._setproperty(66, [arg0], [VT_BOOL])
  @lastargs = WIN32OLE::ARGV
  ret
end
save(arg0)

VOID save save the document to a specified desination

VARIANT arg0 --- desination [IN]
# File ext/win32ole/sample/xml.rb, line 6835
def save(arg0)
  ret = @dispatch._invoke(64, [arg0], [VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end
selectNodes(arg0)

IXMLDOMNodeList selectNodes execute query on the subtree

BSTR arg0 --- queryString [IN]
# File ext/win32ole/sample/xml.rb, line 6680
def selectNodes(arg0)
  ret = @dispatch._invoke(29, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end
selectSingleNode(arg0)

IXMLDOMNode selectSingleNode execute query on the subtree

BSTR arg0 --- queryString [IN]
# File ext/win32ole/sample/xml.rb, line 6689
def selectSingleNode(arg0)
  ret = @dispatch._invoke(30, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end
specified()

BOOL specified indicates whether node is a default value

# File ext/win32ole/sample/xml.rb, line 6377
def specified()
  ret = @dispatch._getproperty(22, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
text()

BSTR text text content of the node and subtree

# File ext/win32ole/sample/xml.rb, line 6369
def text()
  ret = @dispatch._getproperty(24, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
text=(arg0)

VOID text text content of the node and subtree

# File ext/win32ole/sample/xml.rb, line 6537
def text=(arg0)
  ret = @dispatch._setproperty(24, [arg0], [VT_BSTR])
  @lastargs = WIN32OLE::ARGV
  ret
end
transformNode(arg0)

BSTR transformNode apply the stylesheet to the subtree

IXMLDOMNode arg0 --- stylesheet [IN]
# File ext/win32ole/sample/xml.rb, line 6671
def transformNode(arg0)
  ret = @dispatch._invoke(28, [arg0], [VT_BYREF|VT_DISPATCH])
  @lastargs = WIN32OLE::ARGV
  ret
end
transformNodeToObject(arg0, arg1)

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]
# File ext/win32ole/sample/xml.rb, line 6699
def transformNodeToObject(arg0, arg1)
  ret = @dispatch._invoke(35, [arg0, arg1], [VT_BYREF|VT_DISPATCH, VT_VARIANT])
  @lastargs = WIN32OLE::ARGV
  ret
end
url()

BSTR url get the URL for the loaded XML document

# File ext/win32ole/sample/xml.rb, line 6489
def url()
  ret = @dispatch._getproperty(60, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
validateOnParse()

BOOL validateOnParse indicates whether the parser performs validation

# File ext/win32ole/sample/xml.rb, line 6505
def validateOnParse()
  ret = @dispatch._getproperty(65, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end
validateOnParse=(arg0)

VOID validateOnParse indicates whether the parser performs validation

# File ext/win32ole/sample/xml.rb, line 6569
def validateOnParse=(arg0)
  ret = @dispatch._setproperty(65, [arg0], [VT_BOOL])
  @lastargs = WIN32OLE::ARGV
  ret
end
xml()

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

# File ext/win32ole/sample/xml.rb, line 6409
def xml()
  ret = @dispatch._getproperty(27, [], [])
  @lastargs = WIN32OLE::ARGV
  ret
end