Library dxlUtilsBE

Methods Detail

• getAllElementsByName

  Public Function getAllElementsByName(db As NotesDatabase, etype As String, ename As String) As NotesDocumentCollection
  Used to easily get a an array of all elements with the given type and name/alias.
  idx	Argument	Data Type	Attributes	Comments
  1	db	NotesDatabase		database containing the desired design element
  2	etype	String		the type of the desired design element - form or subform, etc.
  3	ename	String		the name of the desired design element

• getElementDXL

  Public Function getElementDXL(db As NotesDatabase, etype As String, formname As String, bkupkey As String, oldnote As NotesDocument) As NotesDOMParser
  Gets the DXL for all requested elements
  idx	Argument	Data Type	Attributes	Comments
  1	db	NotesDatabase		Database from which to get the element DXL
  2	etype	String		the type of the desired design element - form or subform, etc.
  3	formname	String		Name of the form or subform to retrieve
  4	bkupkey	String		key identifying a backup document to be copied (optional)
  5	oldnote	NotesDocument		[OUTBOUND] newly created backup document.

• getElementDXLByNoteID

  Public Function getElementDXLByNoteID(db As NotesDatabase, noteid As String, bkupkey As String, oldnote As NotesDocument) As NotesDOMParser
  Gets the DXL for all requested elements
  idx	Argument	Data Type	Attributes	Comments
  1	db	NotesDatabase		Database from which to get the element DXL
  2	noteid	String		NoteID of the design element to retrive
  3	bkupkey	String		key identifying a backup document to be copied (optional)
  4	oldnote	NotesDocument		[OUTBOUND] newly created backup document.

• getElementHandle

  Public Function getElementHandle(db As NotesDatabase, etype As String, ename As String) As NotesDocument
  used to easily get a handle to a design element.
  idx	Argument	Data Type	Attributes	Comments
  1	db	NotesDatabase		database containing the desired design element
  2	etype	String		the type of the desired design element - form or subform, etc.
  3	ename	String		the name of the desired design element

• getElementNames

  Public Function getElementNames(dnote As NotesDocument, elementName As String, aliases As Variant) As Boolean
  This function returns the name of the given design element in the name param, and the alias(es) of the element in the aliases array NOTE: this function is used by getElementHandle() in this script lib
  idx	Argument	Data Type	Attributes	Comments
  1	dnote	NotesDocument		object handle to the design note
  2	elementName	String		[OUTBOUND] main title/name of the element is retunred on this param
  3	aliases	Variant		[OUTBOUND] array of aliases (minus elementName) is returned on this param

• getElementNoteIDsByName

  Public Function getElementNoteIDsByName(db As NotesDatabase, etype As String, ename As String) As Variant
  sed to easily get a an array of all elements with the given type and name/alias.
  idx	Argument	Data Type	Attributes	Comments
  1	db	NotesDatabase		database containing the desired design element
  2	etype	String		the type of the desired design element - form or subform, etc.
  3	ename	String		the name of the desired design element

• getElementType

  Public Function getElementType(eldoc As NotesDocument) As String
  This function returns the type of a design element by interpreting the $flags field of the element
  idx	Argument	Data Type	Attributes	Comments
  1	eldoc	NotesDocument		object handle to the design note

• importDXL

  Public Function importDXL(tgtDb As NotesDatabase, dxlfile As String, desFlg As Boolean, docFlg As Boolean, aclFlg As Boolean, signFlg As Boolean) As Boolean
  This function is used to import an XML file containing DXL into a database. The XML file can contain DXL for a design element, a document, or the database ACL
  idx	Argument	Data Type	Attributes	Comments
  1	tgtDb	NotesDatabase		the target database for the imported DXL
  2	dxlfile	String		the filepath to the file XML file containing the DXL to be imported
  3	desFlg	Boolean		used to set the replace flag for design elements
  4	docFlg	Boolean		used to set the replace flag for doc elements
  5	aclFlg	Boolean		used to set the replace flag for ACL elements
  6	signFlg	Boolean		if set to True, then the database is signed. WARNING: This can be an expensive setting!

• importDXLStream

  Public Function importDXLStream(tgtDb As NotesDatabase, dxlStream As NotesStream, desFlg As Boolean, docFlg As Boolean, aclFlg As Boolean, signFlg As Boolean) As Boolean
  This function is used to import an XML stream containing DXL into a database. The XML stream can contain DXL for a design element, a document, or the database ACL
  idx	Argument	Data Type	Attributes	Comments
  1	tgtDb	NotesDatabase		the target database for the imported DXL
  2	dxlStream	NotesStream		the filepath to the file XML file containing the DXL to be imported
  3	desFlg	Boolean		used to set the replace flag for design elements
  4	docFlg	Boolean		used to set the replace flag for doc elements
  5	aclFlg	Boolean		used to set the replace flag for ACL elements
  6	signFlg	Boolean		if set to True, then the database is signed. WARNING: This can be an expensive setting!