SIFWorks ADK 2.0
SifWriter Class
NamespacesEdustructures.SifWorksSifWriter

[This is preliminary documentation and is subject to change.]

Declaration Syntax
C#Visual BasicVisual C++
public class SifWriter
Public Class SifWriter
public ref class SifWriter
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
SifWriterSifWriterNew(Stream)
Constructor

SifWriterSifWriterNew(TextWriter)
Creates an instance of a SifWriter using a TextWriter

clearFilter()()
Clears the filter previously set with the setFilter method

Close()()
Closes this stream and the underlying stream

Filter
Places a filter on this SifWriter such that only elements (and their children) identified in the array will be included in the output. Note that attributes are always included even if not specified in the filter list, as are top-level SIF Data Objects like StudentPersonal. The filter remains in effect until the clearFilter method is called or a null array is passed to this method.

Flush()()
Flushes whatever is in the buffer to the underlying streams and also flushes the underlying stream

SerializeIds
Gets or Sets whether SifWriter will get and set xml:id values, using the SifElement XmlId property.s

Write(SifMessagePayload)
Write a SIF Message in the version of SIF in effect for that object. To change the version of SIF that is used, call the SifMessagePayload.setSIFVersion method prior to calling this function.

Write(SifDataObject)
Write a SIF Data Object in the version of SIF in effect for that object. To change the version of SIF that is used, call the SifDataObject.setSIFVersion method prior to calling this function.

Write(SifDataObjectXml)
Write a SIF Data Object to the output stream using whatever XML content is currently defined for that object.

Write(SifElement, SifVersion)
Write a SIF element in the version of SIF specified.

Write(SifElement)
Write a SIF element in the version of SIF currently in effect for this SIFWriter

Inheritance Hierarchy
Object
SifWriter

Assembly: Edustructures.SifWorks.Adk (Module: Edustructures.SifWorks.Adk) Version: 2.0.0.10