Public Class FileResource

Properties Detail

• DOMElement (Get)

  Public Property Get DOMElement As NotesDOMElementNode
  Element node representing the design element.

• DOMParser (Get)

  Public Property Get DOMParser As NotesDOMParser
  DOM parser containing this design element description.

• MimeCharSet (Get)

  Public Property Get MimeCharSet As String
  Use this to read the $MimeCharSet item and discover what character set was used to encode the text file data (if it is text). Note some design elements don't have this because it's assumed based on the design element type.

Methods Detail

• GetFileItem

  Public Function GetFileItem(itemname As FileItem) As FileItem
  Retrieve the FileItem object associated with a CD-record item. An object will be returned even if the item doesn't exist, which you can use to create the item via UpdateFile method. Use this only for items other than the default $FileData item, which you can handle via ReadFileData and UpdateFileData methods.
  idx	Argument	Data Type	Attributes	Comments
  1	itemname	FileItem		Name of the FileItem to retrieve

• HasItem

  Public Function HasItem(itemName As String) As Boolean
  Determine whether there's an item element in the note DXL with a given item name. Note that the presence of an item doesn't guarantee it's formatted as a file CD record.
  idx	Argument	Data Type	Attributes	Comments
  1	itemName	String		Name of the item for which to check.

• Save

  Public Function Save() As Boolean
  Save changes to disk by importing the (presumably modified) DOM tree.

• Delete

  Public Sub Delete()
  Destructor

• DeleteItem

  Public Sub DeleteItem(itemname As String)
  Delete an item with a specified name from the note data.
  idx	Argument	Data Type	Attributes	Comments
  1	itemname	String		Name of the item to be deleted

• New

  Public Sub New(db As NotesDatabase, elElement As NotesDOMDocumentNode, domp As NotesDOMParser)
  Create a new FileResource.
  idx	Argument	Data Type	Attributes	Comments
  1	db	NotesDatabase		database containing the design element.
  2	elElement	NotesDOMDocumentNode		the DOM element corresponding to the design note (e.g. the <note> element).
  3	domp	NotesDOMParser		The DOM parser object containing elElement.

• ReadFileData

  Public Sub ReadFileData(stream As NotesStream)
  Read the file data from the design note. The caller provides a stream to read into, for ease of streaming directly into a disk file (since you have to open the file before writing to the stream).
  idx	Argument	Data Type	Attributes	Comments
  1	stream	NotesStream		Target stream for the file data

• RegisterFileItem

  Public Sub RegisterFileItem(x As FileItem)
  For internal use -- lets the FileItem class notify us that it's referencing our DOM tree so that we can delete the object if we erase the corresponding item element.
  idx	Argument	Data Type	Attributes	Comments
  1	x	FileItem		FileItem objet to be registered.

• UpdateFileData

  Public Sub UpdateFileData()
  Take a binary data stream (it may contain text but we don't care) and update the DOM representation of the note to store that as the filedata. The data ends up stored in the $FileData item, whether this is represented via descriptive format with a <filedata> element, or in note format with an <item> element. We take our cue from whatever was in the DXL when we loaded it.