source: BMXNET_RPMS_dotNET_UTILITIES-BMX/branch/BMX41000/IHS BMX Framework/IndianHealthService.BMXNet.Doc/buildhelp/assembler/Comments/BMXEHR40.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>BMXEHR40</name>
    </assembly>
    <members>
        <member name="T:IndianHealthService.BMXNet.EHR.IEhrComponent">
            <summary>
            To support the HelpFile framework in the EHR menu, your component must
            implement this interface.
            </summary>
        </member>
        <member name="P:IndianHealthService.BMXNet.EHR.IEhrComponent.HelpFile">
            <summary>
            The name of the compiled Windows help file (.chm).  
            </summary>
            <remarks>
            See the EHR/VueCentric integration partial class for details on specifying a HelpFile
            </remarks>
        </member>
        <member name="P:IndianHealthService.BMXNet.EHR.IEhrComponent.HelpContext">
            <summary>
            Not currently used
            </summary>
        </member>
        <member name="P:IndianHealthService.BMXNet.EHR.IEhrComponent.HelpString">
            <summary>
            Not currently used
            </summary>
        </member>
        <member name="M:IndianHealthService.BMXNet.EHR.Model.CiaSession.Close">
            <summary>
            Component is responsible for VueCentric/CSS cleanup
            </summary>
        </member>
        <!-- Badly formed XML comment ignored for member "T:IndianHealthService.BMXNet.EHR.EhrFramework" -->
        <member name="M:IndianHealthService.BMXNet.EHR.EhrFramework.On(CIA_CSS.CSS_Session,IndianHealthService.BMXNet.EHR.IEhrEvents,CIA_CSS.ICSS_SessionEvents)">
            <summary>
            Used to create the single EhrFramework instance used for each EHR/VueCentric-based component
            </summary>
            <remarks>
            Use the provided partial class to construct a UserControl-based component to host in the EHR/VueCentric framework
            </remarks>
            <param name="aCssSession">A COM instance of CSS_Session. The EhrFramework will Release() it</param>
            <param name="anEventSource">The event source bridge to pass events from your COM-Visible control to the EhrFramework</param>
            <param name="sessionEvents">A COM instance of ICSS_SessionEvents. The EhrFramework will Release() it</param>
            <returns></returns>
        </member>
        <member name="M:IndianHealthService.BMXNet.EHR.EhrFramework.Close">
            <summary>
            Close the EhrFramework
            <remarks>
            Releases all COM objects
            </remarks>
            </summary>
        </member>
        <member name="M:IndianHealthService.BMXNet.EHR.EhrFramework.IncomingEventCallback(System.String,System.String)">
            <summary>
            Forward an incoming event from the COM object to the EhrFramework
            </summary>
            <param name="anEventType">This string corresponds to well-known/shared EventTypes used to identify 
            different events published and subscribed within a local desktop application (WinFramework)
            or in the EHR.</param>
            <param name="someDetails">This is an optional peice of data with some event-specific details.</param>
        </member>
        <member name="M:IndianHealthService.BMXNet.EHR.EhrFramework.AttachTo(System.Object)">
            <summary>
            Attach the services to the aConsumer.  This is basically a push of services versus a service lookup.
            aConsumer will be offered to cosume:
            <list>
            LocalSession via LocalConsumer
            RemoteSession via RemoteSessionConsumer
            RemoteSessionPool via RemoteSessionPoolConsumer
            </list>
            </summary>
            <param name="aConsumer">An object optionally implementing LocalConsumer, RemoteSessionConsumer, and/or RemoteSessionPoolConsumer</param>
        </member>
        <member name="P:IndianHealthService.BMXNet.EHR.EhrFramework.LocalSession">
            <summary>
            Access the LocalSession.
            <remarks>
            This is used by the partial class to prime your LocalSessionConsumer implementing control
            </remarks>
            </summary>
        </member>
        <member name="P:IndianHealthService.BMXNet.EHR.EhrFramework.RemoteSession">
            <summary>
            Access the primary RemoteSession.
            <remarks>
            This is used by the partial class to prime your RemoteSessionConsumer implementing control
            </remarks>
            </summary>
        </member>
        <member name="T:IndianHealthService.BMXNet.EHR.IEhrEvents">
            <summary>
            This interface is used to route EHR events to the common BMX context module.  
            </summary>
            <remarks>
            This interface is used by the EHR/VueCentric integration partial class, there is not need for
            BMX developers to directly use this interface
            </remarks>
        </member>
        <member name="E:IndianHealthService.BMXNet.EHR.IEhrEvents.ContextChanged">
            <summary>
            This event is used internally by the EhrFramework
            </summary>
        </member>
        <member name="E:IndianHealthService.BMXNet.EHR.IEhrEvents.ContextChanging">
            <summary>
            This event is used internally by the EhrFramework
            </summary>
        </member>
    </members>
</doc>