RDPAddins.NET/bin/Debug/RDPAddins.Common.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>RDPAddins.Common</name>
    </assembly>
    <members>
        <member name="T:RDPAddins.Common.IAddinMetadata">
            <summary>
            Provides addin's metadata
            </summary>
        </member>
        <member name="P:RDPAddins.Common.IAddinMetadata.AddinName">
            <summary>
            Gets addin name
            </summary>
        </member>
        <member name="P:RDPAddins.Common.IAddinMetadata.ChannelName">
            <summary>
            Get addin channel name
            </summary>
        </member>
        <member name="P:RDPAddins.Common.IAddinMetadata.ChannelOptions">
            <summary>
            Gets channel options
            </summary>
        </member>
        <member name="T:RDPAddins.Common.AddinMetadataAttribute">
            <summary>
            Inherited from System.ComponentModel.Composition.ExportAttribute.
            Every addins should have one as an addin description.
            </summary>
        </member>
        <member name="M:RDPAddins.Common.AddinMetadataAttribute.#ctor(System.String,System.String,RDPAddins.Common.ChannelOptions)">
            <summary>
            Initializes a new instance of the AddinMetadataAttribute class, exporting the type or member marked with this attribute with the specified name, channel name and channel options.
            </summary>
            <param name="AddinName">Name of the addin.</param>
            <param name="ChannelName">!!! should be less than 7 chars !!! Channel name.</param>
            <param name="ChannelOptions">Specified channel's options</param>
        </member>
        <member name="P:RDPAddins.Common.AddinMetadataAttribute.AddinName">
            <summary>
            Gets addin name
            </summary>
        </member>
        <member name="P:RDPAddins.Common.AddinMetadataAttribute.ChannelName">
            <summary>
            Get addin channel name
            </summary>
        </member>
        <member name="P:RDPAddins.Common.AddinMetadataAttribute.ChannelOptions">
            <summary>
            Gets channel options
            </summary>
        </member>
        <member name="T:RDPAddins.Common.ChannelOptions">
            <summary>
            Specifies the options for this virtual channel.
            </summary>
        </member>
        <member name="F:RDPAddins.Common.ChannelOptions.Initialized">
            <summary>
            The channel is initialized.
            </summary>
        </member>
        <member name="F:RDPAddins.Common.ChannelOptions.EncryptRDP">
            <summary>
            Encrypt client-to-server data.
            </summary>
        </member>
        <member name="F:RDPAddins.Common.ChannelOptions.EncryptSC">
            <summary>
            Encrypt server-to-client data.
            </summary>
        </member>
        <member name="F:RDPAddins.Common.ChannelOptions.EncryptCS">
            <summary>
            Encrypt client-to-server data.
            </summary>
        </member>
        <member name="F:RDPAddins.Common.ChannelOptions.PriorityHigh">
            <summary>
            Channel data should be sent with high Multipoint Communications Services (MCS) priority.
            </summary>
        </member>
        <member name="F:RDPAddins.Common.ChannelOptions.PriorityMedium">
            <summary>
            Channel data should be sent with medium MCS priority.
            </summary>
        </member>
        <member name="F:RDPAddins.Common.ChannelOptions.PriorityLow">
            <summary>
            Channel data should be sent with low MCS priority.
            </summary>
        </member>
        <member name="F:RDPAddins.Common.ChannelOptions.CompressRDP">
            <summary>
            Virtual channel data should be compressed if RDP data is being compressed.
            </summary>
        </member>
        <member name="F:RDPAddins.Common.ChannelOptions.Compress">
            <summary>
            Virtual channel data should be compressed, regardless of Remote Desktop Protocol (RDP) compression.
            </summary>
        </member>
        <member name="F:RDPAddins.Common.ChannelOptions.ShowProtocol">
            <summary>
            Affects how data sent by the IChannel.Write function is received at the server end. If this value is set, each data block is preceded by a CHANNEL_PDU_HEADER structure. If this value is not set, the data block includes only the data specified to IChannel.Write.
            </summary>
        </member>
        <member name="T:RDPAddins.Common.IAddin">
            <summary>
            Defines an addin interface.
            </summary>
        </member>
        <member name="M:RDPAddins.Common.IAddin.Initialize(RDPAddins.Common.IChannel)">
            <summary>
            Initializing addin with specific channel
            </summary>
            <param name="Channel">Channel created for this addin.</param>
        </member>
        <member name="T:RDPAddins.Common.IChannel">
            <summary>
            Represents RDS Channel
            </summary>
        </member>
        <member name="E:RDPAddins.Common.IChannel.Initialized">
            <summary>
            Occurs when VirtualChannelInitEventProc(VirtualChannelInitEvent in RDS API) was called with ChannelEvents.Initialized(CHANNEL_EVENT_INITIALIZED in RDS API)
            </summary>
        </member>
        <member name="E:RDPAddins.Common.IChannel.Connected">
            <summary>
            Occurs when VirtualChannelInitEventProc(VirtualChannelInitEvent in RDS API) was called with ChannelEvents.Connected(CHANNEL_EVENT_CONNECTED in RDS API)
            </summary>
        </member>
        <member name="E:RDPAddins.Common.IChannel.Disconnected">
            <summary>
            Occurs when VirtualChannelInitEventProc(VirtualChannelInitEvent in RDS API) was called with ChannelEvents.Disconnected(CHANNEL_EVENT_DISCONNECTED in RDS API)
            </summary>
        </member>
        <member name="E:RDPAddins.Common.IChannel.Terminated">
            <summary>
            Occurs when VirtualChannelInitEventProc(VirtualChannelInitEvent in RDS API) was called with ChannelEvents.Terminated(CHANNEL_EVENT_TERMINATED in RDS API)
            </summary>
        </member>
        <member name="E:RDPAddins.Common.IChannel.DataArrived">
            <summary>
            Occurs when VirtualChannelOpenEvent(VirtualChannelOpenEvent in RDS API) was called with ChannelEvents.DataRecived(CHANNEL_EVENT_DATA_RECEIVED in RDS API)
            </summary>
        </member>
        <member name="M:RDPAddins.Common.IChannel.Read(System.Byte[],System.Int32,System.Int32)">
            <summary>
            Works similar to System.IO.Stream.Read
            </summary>
            <param name="buffer">An array of bytes. When this method returns, the buffer contains the specified byte array with the values between offset and (offset + count - 1) replaced by the bytes read from the channel.</param>
            <param name="offset">The zero-based byte offset in buffer at which to begin storing the data read from the channel.</param>
            <param name="count">The maximum number of bytes to be read from the channel.</param>
            <returns>The total number of bytes read into the buffer. This can be less than the number of bytes requested if that many bytes are not currently available(including 0).</returns>
        </member>
        <member name="M:RDPAddins.Common.IChannel.Write(System.Byte[],System.Int32,System.Int32)">
            <summary>
            Works similar to System.IO.Stream.Write
            </summary>
            <param name="data">An array of bytes. This method sends bytes from buffer through channel.</param>
            <param name="offset">The zero-based byte offset in buffer at which to begin sending bytes through channel.</param>
            <param name="count">The number of bytes to be sent through channel.</param>
        </member>
        <member name="M:RDPAddins.Common.IChannel.GetStream">
            <summary>
            Creataes and returns stream. Stream is disposed when Disconnect event occurs.
            </summary>
            <returns>Retuns stream</returns>
        </member>
        <member name="P:RDPAddins.Common.IChannel.Metadata">
            <summary>
            Gets Addin metadata
            </summary>
        </member>
        <member name="P:RDPAddins.Common.IChannel.UI">
            <summary>
            Get IUI interface
            </summary>
        </member>
        <member name="T:RDPAddins.Common.DataArrivedHandler">
            <summary>
            Represents the method that will handle the DataArrived event of a IChannel.
            </summary>
            <param name="dataLength">Specifies the size, in bytes, of the data. Use Read method of IChannel to read the data.</param>
            <param name="totalLength">Specifies the total size, in bytes, of the data written by a single write operation to the server end of the virtual channel.</param>
            <param name="dataFlags">Provides information about the chunk of data being received.</param>
        </member>
        <member name="T:RDPAddins.Common.DataParts">
            <summary>
            Specifies constants that define which part of data chunk was sent.
            </summary>
        </member>
        <member name="F:RDPAddins.Common.DataParts.First">
            <summary>
            The chunk is the beginning of the data written by a single write operation.
            </summary>
        </member>
        <member name="F:RDPAddins.Common.DataParts.Last">
            <summary>
            The chunk is the end of the data written by a single write operation.
            </summary>
        </member>
        <member name="F:RDPAddins.Common.DataParts.Middle">
            <summary>
            The chunk is in the middle of a block of data written by a single write operation.
            </summary>
        </member>
        <member name="F:RDPAddins.Common.DataParts.Only">
            <summary>
            Combines the DataParts.First and DataParts.Last values. The chunk contains all the data from a single write operation.
            </summary>
        </member>
        <member name="T:RDPAddins.Common.IUI">
            <summary>
            Represents UI parts of the IChannel
            </summary>
        </member>
        <member name="E:RDPAddins.Common.IUI.BalloonTipClicked">
            <summary>
            Occurs when the balloon tip is clicked.
            </summary>
        </member>
        <member name="E:RDPAddins.Common.IUI.ControlCreating">
            <summary>
            Occurs when the hannel is trying create addin's control. If not hooked addin will not have control.
            </summary>
        </member>
        <member name="E:RDPAddins.Common.IUI.MenuCreating">
            <summary>
            Occurs when Channel is trying create addin's menu. If not hooked addin will not have menu.
            </summary>
        </member>
        <member name="E:RDPAddins.Common.IUI.TrayMenuCreating">
            <summary>
            Occurs when Channel is trying create addin's tray menu. If not hooked addin will not have tray menu.
            </summary>
        </member>
        <member name="E:RDPAddins.Common.IUI.IconCreating">
            <summary>
            Occurs when Channel is trying to get addin's icon. Only appears when addin has control. If not hooked addin and addin has control then addin will have default icon.
            </summary>
        </member>
        <member name="P:RDPAddins.Common.IUI.Parent">
            <summary>
            Get UI's channel
            </summary>
        </member>
        <member name="M:RDPAddins.Common.IUI.ShowBalloonTip(System.Int32,System.String,System.String,System.Windows.Forms.ToolTipIcon,System.Object)">
            <summary>
            Displays the balloon tip in the taskbar.
            </summary>
            <param name="timeout">The time period, in milliseconds, the balloon tip should display.</param>
            <param name="tipTitle">The title to display on the balloon tip.</param>
            <param name="tipText">The text to display on the balloon tip.</param>
            <param name="tipIcon">One of the System.Windows.Forms.ToolTipIcon values.</param>
            <param name="context">This object will sent to BalloonTipClicked event.</param>
        </member>
        <member name="M:RDPAddins.Common.IUI.ShowControl">
            <summary>
            Shows main form and selct tab with addin's control(if exists).
            </summary>
        </member>
        <member name="M:RDPAddins.Common.IUI.DoOnUIThread(System.Action)">
            <summary>
            Executes a action on the UI thread. (It calls System.Windows.Forms.Form.Invoke).
            </summary>
            <param name="action">The action delegate.</param>
        </member>
        <member name="P:RDPAddins.Common.IUI.Visible">
            <summary>
            Gets or sets visibility of addin's control(if exists).
            </summary>
        </member>
        <member name="T:RDPAddins.Common.BalloonTipClickedHandler">
            <summary>
            Represents the method that will handle the BalloonTipClicked event of a IUI.
            </summary>
            <param name="sender">The source of the event.</param>
            <param name="context">Parameter sent by IUI.ShowBalloonTip method.</param>
        </member>
        <member name="T:RDPAddins.Common.ControlCreatingHandler">
            <summary>
            Represents the method that will handle the ControlCreating event of a IUI.
            </summary>
            <param name="sender">The source of the event.</param>
            <returns>Should returns addin's control if needed.</returns>
        </member>
        <member name="T:RDPAddins.Common.MenuCreatingHandler">
            <summary>
            Represents the method that will handle the MenuCreating and TrayMenuCreating event of a IUI.
            </summary>
            <param name="sender">The source of the event.</param>
            <returns>Should returns addin's menu or tray menu if needed.</returns>
        </member>
        <member name="T:RDPAddins.Common.IconCreatingHandler">
            <summary>
            Represents the method that will handle the IconCreating event of a IUI.
            </summary>
            <param name="sender">The source of the event.</param>
            <returns>Should returns addin's icon if needed.</returns>
        </member>
    </members>
</doc>