Library DOMUtils

Methods Detail

• DU_GetChildNamed

  Public Function DU_GetChildNamed(target As String, dome As NotesDOMElementNode) As NotesDOMElementNode
  Given a name and an element, find the first child of that element with the given tag name.
  idx	Argument	Data Type	Attributes	Comments
  1	target	String	ByVal	Name of the element to retrieve
  2	dome	NotesDOMElementNode		Node within which to search for the target child node.

• DU_GetChildOfType

  Public Function DU_GetChildOfType(elParent As NotesDOMElementNode, seekType As Long) As NotesDOMNode
  Get the first child of an element node that has a particular type.
  idx	Argument	Data Type	Attributes	Comments
  1	elParent	NotesDOMElementNode		node whose child we seek.
  2	seekType	Long		the node type we want. Legal values: DOMNODETYPE_ELEMENT_NODE (1) DOMNODETYPE_TEXT_NODE (3) DOMNODETYPE_CDATASECTION_NODE (4) DOMNODETYPE_COMMENT_NODE (8) ...and others but you're unlikely to use them.

• DU_GetChildWithAttr

  Public Function DU_GetChildWithAttr(elParent As NotesDOMDocumentNode, targetElement As String, attrName As String, attrValue As String, flags As Long) As NotesDOMElementNode
  Find a child DOM node with an attribute that has a particular value. Does not recurse into the tree; looking only for immediate descendants.
  idx	Argument	Data Type	Attributes	Comments
  1	elParent	NotesDOMDocumentNode		node whose children you want to search.
  2	targetElement	String	ByVal	element name of desired child node.
  3	attrName	String	ByVal	attribute name you want to check.
  4	attrValue	String	ByVal	attribute value of element you're looking for.
  5	flags	Long	ByVal	string-matching flags to compare attribute, e.g. 1 for case insensitive.
  Code Sample
  Set titleItem = DU_GetChildWithAttr(elView, "item", "name", "$title", 1) ' finds the first "item" element where name='$title' (case insensitive).

• DU_GetDocNode

  Public Function DU_GetDocNode(node As NotesDOMNode) As NotesDOMDocumentNode
  Find the DOM "document" node from which a given node was derived. The doc node is needed to create new nodes.
  idx	Argument	Data Type	Attributes	Comments
  1	node	NotesDOMNode		Node for which to find the Document node.

• DU_GetNextElement

  Public Function DU_GetNextElement(elCur As NotesDOMElementNode) As NotesDOMElementNode
  Given a DOM element, find its next sibling that's an element (in other words, skip over text and other nodes).
  idx	Argument	Data Type	Attributes	Comments
  1	elCur	NotesDOMElementNode		Node for which to find the next sibling.

• DU_GetTextChild

  Public Function DU_GetTextChild(el As NotesDOMElementNode) As NotesDOMTextNode
  Return the first DOM text node which is a child of the specified node.
  idx	Argument	Data Type	Attributes	Comments
  1	el	NotesDOMElementNode		Note from which to retrieve for the child node.

• DU_GetTextFromNode

  Public Function DU_GetTextFromNode(dome As NotesDOMElementNode) As String
  Passed a DOM element node that has a text node as one of its children, return the text from that node.
  idx	Argument	Data Type	Attributes	Comments
  1	dome	NotesDOMElementNode		Node for which to retrieve the text of the child node.

• StreamToBase64

  Public Function StreamToBase64(streamIn As NotesStream) As String
  Convert a binary NotesStream to a string of Base64 data. The output can be used as part of DXL data for importing.
  idx	Argument	Data Type	Attributes	Comments
  1	streamIn	NotesStream		Binary strem from which to get the base64 encoded data

• StreamToText

  Public Function StreamToText(streamIn As NotesStream, chrset As String) As String
  Convert a NotesStream to text in a specified character set. The default is to interpret NotesStreams as Unicode unless they are attached to a file; this lets you override that.
  idx	Argument	Data Type	Attributes	Comments
  1	streamIn	NotesStream		Stream to be converted to text.
  2	chrset	String	ByVal	Character set to use for the conversion.

• TextToStream

  Public Function TextToStream(szText As String, chrset As String) As NotesStream
  Produce a stream in a specified character set without opening a file. Unfortunately the NotesStream.charset attribute will still be the default Unicode, but the bytes in the stream will be correct. At some point we may be able to correcte this by assigning the Charset property and then adding text, but not yet.
  idx	Argument	Data Type	Attributes	Comments
  1	szText	String		Text to be converted to a stream
  2	chrset	String	ByVal	Character set to use

• Base64ToBinary

  Public Sub Base64ToBinary(strBase64 As String, streamOut As NotesStream)
  Given a string of base64-encoded data, write into a binary stream we are passed. This is done rather than creating the stream here and returning it, so that you can stream directly into a file if you choose.
  idx	Argument	Data Type	Attributes	Comments
  1	strBase64	String		Base64 encoded data string to be written to streamOut
  2	streamOut	NotesStream		target stream to be written to