DesktopMagic/_src/DesktopMagicPluginAPI/DesktopMagicPluginAPI.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>DesktopMagicPluginAPI</name>
    </assembly>
    <members>
        <member name="T:DesktopMagicPluginAPI.Drawing.GraphicsExtentions">
            <summary>
            Extensions for the <see cref="T:System.Drawing.Graphics"/> class.
            </summary>
        </member>
        <member name="M:DesktopMagicPluginAPI.Drawing.GraphicsExtentions.DrawStringMonospace(System.Drawing.Graphics,System.String,System.Drawing.Font,System.Drawing.Brush,System.Single,System.Single)">
            <summary>
            <inheritdoc cref="M:System.Drawing.Graphics.DrawString(System.String,System.Drawing.Font,System.Drawing.Brush,System.Single,System.Single)"/>
            </summary>
            <param name="graphics">Graphics object.</param>
            <param name="s">String to draw.</param>
            <param name="font"><see cref="T:System.Drawing.Font"/> that defines the text format of the string.</param>
            <param name="brush"><see cref="T:System.Drawing.Brush"/> that determines the color and texture of the drawn text.</param>
            <param name="x">The x-coordinate of the upper-left corner of the drawn text.</param>
            <param name="y">The y-coordinate of the upper-left corner of the drawn text.</param>
        </member>
        <member name="M:DesktopMagicPluginAPI.Drawing.GraphicsExtentions.DrawStringMonospace(System.Drawing.Graphics,System.String,System.Drawing.Font,System.Drawing.Brush,System.Drawing.PointF)">
            <summary>
            <inheritdoc cref="M:System.Drawing.Graphics.DrawString(System.String,System.Drawing.Font,System.Drawing.Brush,System.Drawing.PointF)"/>
            </summary>
            <param name="graphics">Graphics object.</param>
            <param name="s">String to draw.</param>
            <param name="font"><see cref="T:System.Drawing.Font"/> that defines the text format of the string.</param>
            <param name="brush"><see cref="T:System.Drawing.Brush"/> that determines the color and texture of the drawn text.</param>
            <param name="point"><see cref="T:System.Drawing.PointF"/> structure that specifies the upper-left corner of the drawn text.</param>
        </member>
        <member name="M:DesktopMagicPluginAPI.Drawing.GraphicsExtentions.DrawStringFixedWidth(System.Drawing.Graphics,System.String,System.Drawing.Font,System.Drawing.Brush,System.Single,System.Single,System.Single)">
            <summary>
            <inheritdoc cref="M:System.Drawing.Graphics.DrawString(System.String,System.Drawing.Font,System.Drawing.Brush,System.Single,System.Single)"/>
            </summary>
            <param name="graphics">Graphics object.</param>
            <param name="s">String to draw.</param>
            <param name="font"><see cref="T:System.Drawing.Font"/> that defines the text format of the string.</param>
            <param name="brush"><see cref="T:System.Drawing.Brush"/> that determines the color and texture of the drawn text.</param>
            <param name="x">The x-coordinate of the upper-left corner of the drawn text.</param>
            <param name="y">The y-coordinate of the upper-left corner of the drawn text.</param>
            /// <param name="width">The specified width.</param>
        </member>
        <member name="M:DesktopMagicPluginAPI.Drawing.GraphicsExtentions.DrawStringFixedWidth(System.Drawing.Graphics,System.String,System.Drawing.Font,System.Drawing.Brush,System.Drawing.PointF,System.Single)">
            <summary>
            <inheritdoc cref="M:System.Drawing.Graphics.DrawString(System.String,System.Drawing.Font,System.Drawing.Brush,System.Drawing.PointF)"/>
            </summary>
            <param name="graphics">Graphics object.</param>
            <param name="s">String to draw.</param>
            <param name="font"><see cref="T:System.Drawing.Font"/> that defines the text format of the string.</param>
            <param name="brush"><see cref="T:System.Drawing.Brush"/> that determines the color and texture of the drawn text.</param>
            <param name="point"><see cref="T:System.Drawing.PointF"/> structure that specifies the upper-left corner of the drawn text.</param>
            <param name="width">The specified width.</param>
        </member>
        <member name="M:DesktopMagicPluginAPI.Drawing.GraphicsExtentions.DrawStringNoLeftPadding(System.Drawing.Graphics,System.String,System.Drawing.Font,System.Drawing.Brush,System.Single,System.Single)">
             <summary>
            <inheritdoc cref="M:System.Drawing.Graphics.DrawString(System.String,System.Drawing.Font,System.Drawing.Brush,System.Single,System.Single)"/>
             </summary>
             <param name="graphics">Graphics object.</param>
             <param name="s">String to draw.</param>
             <param name="font"><see cref="T:System.Drawing.Font"/> that defines the text format of the string.</param>
             <param name="brush"><see cref="T:System.Drawing.Brush"/> that determines the color and texture of the drawn text.</param>
             <param name="x">The x-coordinate of the upper-left corner of the drawn text.</param>
             <param name="y">The y-coordinate of the upper-left corner of the drawn text.</param>
        </member>
        <member name="M:DesktopMagicPluginAPI.Drawing.GraphicsExtentions.DrawStringNoLeftPadding(System.Drawing.Graphics,System.String,System.Drawing.Font,System.Drawing.Brush,System.Drawing.PointF)">
            <summary>
            <inheritdoc cref="M:System.Drawing.Graphics.DrawString(System.String,System.Drawing.Font,System.Drawing.Brush,System.Drawing.PointF)"/>
            </summary>
            <param name="graphics">Graphics object.</param>
            <param name="s">String to draw.</param>
            <param name="font"><see cref="T:System.Drawing.Font"/> that defines the text format of the string.</param>
            <param name="brush"><see cref="T:System.Drawing.Brush"/> that determines the color and texture of the drawn text.</param>
            <param name="point"><see cref="T:System.Drawing.PointF"/> structure that specifies the upper-left corner of the drawn text.</param>
        </member>
        <member name="M:DesktopMagicPluginAPI.Drawing.GraphicsExtentions.MeasureStringNoLeftPadding(System.Drawing.Graphics,System.String,System.Drawing.Font)">
            <summary>
            <inheritdoc cref="M:System.Drawing.Graphics.MeasureString(System.String,System.Drawing.Font)"/>
            </summary>
            <param name="graphics">Graphics object.</param>
            <param name="text">String to measure.</param>
            <param name="font"><see cref="T:System.Drawing.Font"/> that defines the text format of the string.</param>
            <returns></returns>
        </member>
        <member name="T:DesktopMagicPluginAPI.Drawing.RenderQuality">
            <summary>
            Specifies which render quality is used to display the bitmap images.
            </summary>
        </member>
        <member name="F:DesktopMagicPluginAPI.Drawing.RenderQuality.High">
            <summary>
            Slower then <see cref="F:DesktopMagicPluginAPI.Drawing.RenderQuality.Low"/> but produces higher quality output.
            </summary>
        </member>
        <member name="F:DesktopMagicPluginAPI.Drawing.RenderQuality.Low">
            <summary>
            Faster then <see cref="F:DesktopMagicPluginAPI.Drawing.RenderQuality.High"/> but produces lower quality output.
            </summary>
        </member>
        <member name="F:DesktopMagicPluginAPI.Drawing.RenderQuality.Performance">
            <summary>
            Provides performance benefits over <see cref="F:DesktopMagicPluginAPI.Drawing.RenderQuality.Low"/>
            </summary>
        </member>
        <member name="T:DesktopMagicPluginAPI.Inputs.Button">
            <summary>
            Represents a button control.
            </summary>
        </member>
        <member name="E:DesktopMagicPluginAPI.Inputs.Button.OnClick">
            <summary>
            Occurs when the button gets clicked.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.Inputs.Button.Value">
            <summary>
            Gets or sets the text caption displayed in the <see cref="T:DesktopMagicPluginAPI.Inputs.Button"/> element.
            </summary>
        </member>
        <member name="M:DesktopMagicPluginAPI.Inputs.Button.#ctor(System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:DesktopMagicPluginAPI.Inputs.Button"/> class with the provided <paramref name="value"/>.
            </summary>
            <param name="value">The text caption displayed in the <see cref="T:DesktopMagicPluginAPI.Inputs.Button"/> control.</param>
        </member>
        <member name="M:DesktopMagicPluginAPI.Inputs.Button.Click">
            <summary>
            Triggers the <see cref="E:DesktopMagicPluginAPI.Inputs.Button.OnClick"/> event.
            </summary>
        </member>
        <member name="T:DesktopMagicPluginAPI.Inputs.CheckBox">
            <summary>
            Represents a check box control.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.Inputs.CheckBox.Value">
            <summary>
            Gets or set a value indicating whether the <see cref="T:DesktopMagicPluginAPI.Inputs.CheckBox"/> is in the checked state.
            </summary>
        </member>
        <member name="M:DesktopMagicPluginAPI.Inputs.CheckBox.#ctor(System.Boolean)">
            <summary>
            Initializes a new instance of the <see cref="T:DesktopMagicPluginAPI.Inputs.CheckBox"/> class with the provided <paramref name="value"/>.
            </summary>
            <param name="value">A value indicating whether the <see cref="T:DesktopMagicPluginAPI.Inputs.CheckBox"/> is in the checked state.</param>
        </member>
        <member name="T:DesktopMagicPluginAPI.Inputs.ComboBox">
            <summary>
            Represents a selection control with a drop-down list.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.Inputs.ComboBox.Items">
            <summary>
            Gets the collection used to generate the content of the <see cref="T:DesktopMagicPluginAPI.Inputs.ComboBox"/>.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.Inputs.ComboBox.Value">
            <summary>
            Gets the currently selected item associated with this <see cref="T:DesktopMagicPluginAPI.Inputs.ComboBox"/>.
            </summary>
            <remarks>If you assign a value to this property, the displayed text in the user interface will not be changed.</remarks>
        </member>
        <member name="M:DesktopMagicPluginAPI.Inputs.ComboBox.#ctor(System.String[])">
            <summary>
            Initializes a new instance of the <see cref="T:DesktopMagicPluginAPI.Inputs.Label"/> class with the provided <paramref name="items"/>.
            </summary>
            <param name="items"></param>
        </member>
        <member name="T:DesktopMagicPluginAPI.Inputs.Element">
            <summary>
            The element base class.
            </summary>
        </member>
        <member name="E:DesktopMagicPluginAPI.Inputs.Element.OnValueChanged">
            <summary>
            Occurs when the value has been changed.
            </summary>
        </member>
        <member name="M:DesktopMagicPluginAPI.Inputs.Element.ValueChanged">
            <summary>
            Triggers the <see cref="E:DesktopMagicPluginAPI.Inputs.Element.OnValueChanged"/> event.
            </summary>
        </member>
        <member name="T:DesktopMagicPluginAPI.Inputs.ElementAttribute">
            <summary>
            Marks a Property as element.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.Inputs.ElementAttribute.Name">
            <summary>
            The name of the element.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.Inputs.ElementAttribute.OrderIndex">
            <summary>
            The order index of the element.
            </summary>
        </member>
        <member name="M:DesktopMagicPluginAPI.Inputs.ElementAttribute.#ctor(System.String,System.Int32)">
            <summary>
            Marks a Property as element with the provided <paramref name="name"/> and <paramref name="orderIndex"/>.
            </summary>
            <param name="name">The name of the element.</param>
            <param name="orderIndex">The order index of the element.</param>
        </member>
        <member name="M:DesktopMagicPluginAPI.Inputs.ElementAttribute.#ctor(System.Int32)">
            <summary>
            Marks a Property as element with the provided <paramref name="orderIndex"/>.
            </summary>
            <param name="orderIndex">The order index of the element.</param>
        </member>
        <member name="M:DesktopMagicPluginAPI.Inputs.ElementAttribute.#ctor">
            <inheritdoc cref="T:DesktopMagicPluginAPI.Inputs.ElementAttribute"/>
        </member>
        <member name="T:DesktopMagicPluginAPI.Inputs.IntegerUpDown">
            <summary>
            Represents a up-down control.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.Inputs.IntegerUpDown.Maximum">
            <summary>
            Gets or sets the maximum value for the <see cref="T:DesktopMagicPluginAPI.Inputs.IntegerUpDown"/> element.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.Inputs.IntegerUpDown.Minimum">
            <summary>
            Gets or sets the minimum value for the <see cref="T:DesktopMagicPluginAPI.Inputs.IntegerUpDown"/> element.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.Inputs.IntegerUpDown.Value">
            <summary>
            Gets or sets the value assigned to the <see cref="T:DesktopMagicPluginAPI.Inputs.IntegerUpDown"/> element.
            </summary>
        </member>
        <member name="M:DesktopMagicPluginAPI.Inputs.IntegerUpDown.#ctor(System.Int32,System.Int32,System.Int32)">
            <summary>
            Initializes a new instance of the <see cref="T:DesktopMagicPluginAPI.Inputs.IntegerUpDown"/> class with the provided <paramref name="min"/> value, <paramref name="max"/> value and <paramref name="value"/>.
            </summary>
            <param name="min">The maximum value for the <see cref="T:DesktopMagicPluginAPI.Inputs.IntegerUpDown"/> element.</param>
            <param name="max">The minimum value for the <see cref="T:DesktopMagicPluginAPI.Inputs.IntegerUpDown"/> element.</param>
            <param name="value">The value assigned to the <see cref="T:DesktopMagicPluginAPI.Inputs.IntegerUpDown"/> element.</param>
            <exception cref="T:System.ArgumentException"></exception>
        </member>
        <member name="T:DesktopMagicPluginAPI.Inputs.Label">
            <summary>
            Represents a label control.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.Inputs.Label.Value">
            <summary>
            Gets or sets the text associated with this <see cref="T:DesktopMagicPluginAPI.Inputs.Label"/>.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.Inputs.Label.Bold">
            <summary>
            Gets or set a value indicating whether the content of the <see cref="T:DesktopMagicPluginAPI.Inputs.Label"/> is bold or not.
            </summary>
        </member>
        <member name="M:DesktopMagicPluginAPI.Inputs.Label.#ctor(System.String,System.Boolean)">
            <summary>
            Initializes a new instance of the <see cref="T:DesktopMagicPluginAPI.Inputs.Label"/> class with the provided <paramref name="value"/>.
            </summary>
            <param name="value">The text associated with this <see cref="T:DesktopMagicPluginAPI.Inputs.Label"/></param>
            <param name="bold">A value indicating whether the content of the <see cref="T:DesktopMagicPluginAPI.Inputs.Label"/> is bold or not.</param>
        </member>
        <member name="T:DesktopMagicPluginAPI.Inputs.MouseButton">
            <summary>
            Mouse Buttons
            </summary>
        </member>
        <member name="F:DesktopMagicPluginAPI.Inputs.MouseButton.Left">
            <summary>
            The left mouse button.
            </summary>
        </member>
        <member name="F:DesktopMagicPluginAPI.Inputs.MouseButton.Middle">
            <summary>
            The middle mouse button.
            </summary>
        </member>
        <member name="F:DesktopMagicPluginAPI.Inputs.MouseButton.Right">
            <summary>
             The right mouse button.
            </summary>
        </member>
        <member name="T:DesktopMagicPluginAPI.Inputs.Slider">
            <summary>
            Represents a slider control.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.Inputs.Slider.Maximum">
            <summary>
            Gets or sets the maximum value for the <see cref="T:DesktopMagicPluginAPI.Inputs.Slider"/> element.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.Inputs.Slider.Minimum">
            <summary>
            Gets or sets the minimum value for the <see cref="T:DesktopMagicPluginAPI.Inputs.Slider"/> element.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.Inputs.Slider.Value">
            <summary>
            Gets or sets the value assigned to the <see cref="T:DesktopMagicPluginAPI.Inputs.Slider"/> element.
            </summary>
        </member>
        <member name="M:DesktopMagicPluginAPI.Inputs.Slider.#ctor(System.Double,System.Double,System.Double)">
            <summary>
            Initializes a new instance of the <see cref="T:DesktopMagicPluginAPI.Inputs.Slider"/> class with the provided <paramref name="min"/> value, <paramref name="max"/> value and <paramref name="value"/>.
            </summary>
            <param name="min">The maximum value for the <see cref="T:DesktopMagicPluginAPI.Inputs.Slider"/> element.</param>
            <param name="max">The minimum value for the <see cref="T:DesktopMagicPluginAPI.Inputs.Slider"/> element.</param>
            <param name="value">The value assigned to the <see cref="T:DesktopMagicPluginAPI.Inputs.Slider"/> element.</param>
        </member>
        <member name="T:DesktopMagicPluginAPI.Inputs.TextBox">
            <summary>
            Represents a text box control.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.Inputs.TextBox.Value">
            <summary>
            Gets or sets the text associated with this <see cref="T:DesktopMagicPluginAPI.Inputs.TextBox"/>.
            </summary>
        </member>
        <member name="M:DesktopMagicPluginAPI.Inputs.TextBox.#ctor(System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:DesktopMagicPluginAPI.Inputs.TextBox"/> class with the provided <paramref name="value"/>.
            </summary>
            <param name="value">The text associated with this control.</param>
        </member>
        <member name="T:DesktopMagicPluginAPI.IPluginData">
            <summary>
             Defines properties and methods that provide information about the main application.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.IPluginData.Font">
            <summary>
            Gets the current font of the current theme.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.IPluginData.Color">
            <summary>
            Gets the current color of the current theme.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.IPluginData.Theme">
            <summary>
            Gets the current theme setting of the main application.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.IPluginData.WindowSize">
            <summary>
            Gets the window size of the plugin window.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.IPluginData.WindowPosition">
            <summary>
            Gets the window position of the plugin window.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.IPluginData.PluginName">
            <summary>
            Gets the name of the plugin.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.IPluginData.PluginPath">
            <summary>
            Gets the path of the parent directory of the plugin.
            </summary>
        </member>
        <member name="M:DesktopMagicPluginAPI.IPluginData.UpdateWindow">
            <summary>
            Updates the plugin window.
            </summary>
        </member>
        <member name="T:DesktopMagicPluginAPI.ITheme">
            <summary>
            The theme settings of the main application.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.ITheme.PrimaryColor">
            <summary>
            Gets the primary color of the current theme.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.ITheme.SecondaryColor">
            <summary>
            Gets the secondary color of the current theme.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.ITheme.BackgroundColor">
            <summary>
            Gets the background color of the current theme.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.ITheme.Font">
            <summary>
            Gets the font of the current theme.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.ITheme.CornerRadius">
            <summary>
            Gets the corner radius of the current theme.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.ITheme.Margin">
            <summary>
            Gets the corner radius of the current theme.
            </summary>
        </member>
        <member name="T:DesktopMagicPluginAPI.Plugin">
            <summary>
            The plugin class.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.Plugin.Application">
            <summary>
            Informations about the main application.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.Plugin.UpdateInterval">
            <summary>
            Gets or sets the interval, expressed in milliseconds, at which to call the <see cref="M:DesktopMagicPluginAPI.Plugin.Main"/> method.
            </summary>
        </member>
        <member name="P:DesktopMagicPluginAPI.Plugin.RenderQuality">
            <summary>
            Gets or sets the render quality of the bitmap image.
            </summary>
        </member>
        <member name="M:DesktopMagicPluginAPI.Plugin.Start">
            <summary>
            Occurs once when the plugin gets activated.
            </summary>
        </member>
        <member name="M:DesktopMagicPluginAPI.Plugin.Stop">
            <summary>
            Occurs once when the plugin gets deactivated.
            </summary>
        </member>
        <member name="M:DesktopMagicPluginAPI.Plugin.Main">
            <summary>
            Occurs when the <see cref="P:DesktopMagicPluginAPI.Plugin.UpdateInterval"/> elapses.
            </summary>
            <returns></returns>
        </member>
        <member name="M:DesktopMagicPluginAPI.Plugin.OnMouseClick(System.Drawing.Point,DesktopMagicPluginAPI.Inputs.MouseButton)">
            <summary>
            Occurs when the window is clicked by the mouse.
            </summary>
            <param name="position">The x- and y-coordinates of the mouse pointer position relative to the plugin window.</param>
            <param name="mouseButton">The button associated with the event.</param>
        </member>
        <member name="M:DesktopMagicPluginAPI.Plugin.OnMouseMove(System.Drawing.Point)">
            <summary>
            Occurs when the mouse pointer is moved over the control.
            </summary>
            <param name="position">The x- and y-coordinates of the mouse pointer position relative to the plugin window.</param>
        </member>
        <member name="M:DesktopMagicPluginAPI.Plugin.OnMouseWheel(System.Drawing.Point,System.Int32)">
            <summary>
            Occurs when the user rotates the mouse wheel while the mouse pointer is over this element.
            </summary>
            <param name="position">The x- and y-coordinates of the mouse pointer position relative to the plugin window.</param>
            <param name="delta">A value that indicates the amount that the mouse wheel has changed.</param>
        </member>
    </members>
</doc>