Gallio.Reports.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Gallio.Reports</name>
    </assembly>
    <members>
        <member name="T:Gallio.Reports.BaseReportFormatter">
            <summary>
            Abstract base class for report formatters.
            </summary>
        </member>
        <member name="F:Gallio.Reports.BaseReportFormatter.AttachmentContentDispositionOption">
            <summary>
            Gets the name of the option that how attachments are saved.
            </summary>
        </member>
        <member name="M:Gallio.Reports.BaseReportFormatter.#ctor">
            <summary>
            Creates a report formatter.
            </summary>
        </member>
        <member name="M:Gallio.Reports.BaseReportFormatter.GetAttachmentContentDisposition(Gallio.Runner.Reports.ReportFormatterOptions)">
            <summary>
            Gets the attachment content disposition.
            </summary>
            <param name="options">The formatter options.</param>
            <returns>The attachment content disposition.</returns>
        </member>
        <member name="M:Gallio.Reports.BaseReportFormatter.Format(Gallio.Runner.Reports.IReportWriter,Gallio.Runner.Reports.ReportFormatterOptions,Gallio.Runtime.ProgressMonitoring.IProgressMonitor)">
            <inheritdoc />
        </member>
        <member name="P:Gallio.Reports.BaseReportFormatter.DefaultAttachmentContentDisposition">
            <summary>
            Gets or sets the default attachment content disposition.
            Defaults to <see cref="F:Gallio.Common.Markup.AttachmentContentDisposition.Absent"/>.
            </summary>
        </member>
        <member name="T:Gallio.Reports.MHtmlReportFormatter">
            <summary>
            <para>
            Formats MIME HTML archive reports similar to the web archives generated by Internet Explorer.
            The report can then be sent to recipients as a single file.
            </para>
            <para>
            Unfortunately the format is non-standard and cannot be read by most other browsers.
            </para>
            </summary>
        </member>
        <member name="M:Gallio.Reports.MHtmlReportFormatter.#ctor(Gallio.Runner.Reports.IReportFormatter)">
            <summary>
            Creates a report formatter.
            </summary>
            <param name="htmlReportFormatter">The HTML report formatter.</param>
            <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="htmlReportFormatter"/> is null.</exception>
        </member>
        <member name="M:Gallio.Reports.MHtmlReportFormatter.Format(Gallio.Runner.Reports.IReportWriter,Gallio.Runner.Reports.ReportFormatterOptions,Gallio.Runtime.ProgressMonitoring.IProgressMonitor)">
            <inheritdoc />
        </member>
        <member name="T:Gallio.Reports.MultipartMimeReportContainer">
            <summary>
            A report container that saves a report as a multipart mime archive in a single file
            within another container.
            </summary>
            <remarks>
            This is currently specialized for saving HTML reports.
            It does not support loading reports.
            </remarks>
        </member>
        <member name="M:Gallio.Reports.MultipartMimeReportContainer.#ctor(Gallio.Runner.Reports.IReportContainer)">
            <summary>
            Creates the multipart mime report container.
            </summary>
            <param name="inner">The container to which the archived report should be saved.</param>
            <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="inner"/> is null.</exception>
        </member>
        <member name="M:Gallio.Reports.MultipartMimeReportContainer.OpenArchive(System.String)">
            <summary>
            Opens the archive within the inner container.
            </summary>
            <param name="archivePath">The path of the archive to create.</param>
            <exception cref="T:System.ArgumentNullException">Thrown if <paramref name="archivePath"/> is null.</exception>
            <exception cref="T:System.InvalidOperationException">Thrown if the archive has already been opened.</exception>
        </member>
        <member name="M:Gallio.Reports.MultipartMimeReportContainer.CloseArchive">
            <summary>
            Finishes writing out the MIME archive and closes it.
            Does nothing if the archive is not open.
            </summary>
        </member>
        <member name="P:Gallio.Reports.MultipartMimeReportContainer.ReportName">
            <inheritdoc />
        </member>
        <member name="T:Gallio.Reports.NamespaceDoc">
            <summary>
            The Gallio.Reports namespace provides report formatters for common Gallio test report types.
            </summary>
        </member>
        <member name="T:Gallio.Reports.Properties.Resources">
            <summary>
              A strongly-typed resource class, for looking up localized strings, etc.
            </summary>
        </member>
        <member name="P:Gallio.Reports.Properties.Resources.ResourceManager">
            <summary>
              Returns the cached ResourceManager instance used by this class.
            </summary>
        </member>
        <member name="P:Gallio.Reports.Properties.Resources.Culture">
            <summary>
              Overrides the current thread's CurrentUICulture property for all
              resource lookups using this strongly typed resource class.
            </summary>
        </member>
        <member name="T:Gallio.Reports.ReportResourcesInstaller">
            <summary>
            Installs derived resources for reports such as test framework icons.
            </summary>
        </member>
        <member name="M:Gallio.Reports.ReportResourcesInstaller.#ctor(Gallio.Model.ITestKindManager,System.IO.DirectoryInfo,System.IO.FileInfo)">
            <summary>
            Initializes the installer.
            </summary>
            <param name="testKindManager">The test kind manager, not null.</param>
            <param name="testKindImageDir">The test kind image directory, not null.</param>
            <param name="generatedCssFile">The generated CSS file, not null.</param>
        </member>
        <member name="M:Gallio.Reports.ReportResourcesInstaller.Install(Gallio.Runtime.ProgressMonitoring.IProgressMonitor)">
            <inheritdoc />
        </member>
        <member name="T:Gallio.Reports.XmlReportFormatter">
            <summary>
            Formats reports as Xml.
            </summary>
            <remarks>
            <para>
            Recognizes the following options:
            <list type="bullet">
            <listheader>
            <term>Option</term>
            <description>Description</description>
            </listheader>
            <item>
            <term>AttachmentContentDisposition</term>
            <description>Overrides the default attachment content disposition for the format.
            The content disposition may be "Absent" to exclude attachments, "Link" to
            include attachments by reference to external files, or "Inline" to include attachments as
            inline content within the formatted document.  Different formats use different
            default content dispositions.</description>
            </item>
            </list>
            </para>
            </remarks>
        </member>
        <member name="M:Gallio.Reports.XmlReportFormatter.#ctor">
            <summary>
            Creates an Xml report formatter.
            </summary>
        </member>
        <member name="M:Gallio.Reports.XmlReportFormatter.Format(Gallio.Runner.Reports.IReportWriter,Gallio.Runner.Reports.ReportFormatterOptions,Gallio.Runtime.ProgressMonitoring.IProgressMonitor)">
            <inheritdoc />
        </member>
        <member name="T:Gallio.Reports.XsltReportFormatter">
            <summary>
            <para>
            Generic XSLT report formatter.
            </para>
            <para>
            Recognizes the following options:
            <list type="bullet">
            <listheader>
            <term>Option</term>
            <description>Description</description>
            </listheader>
            <item>
            <term>AttachmentContentDisposition</term>
            <description>Overrides the default attachment content disposition for the format.
            The content disposition may be "Absent" to exclude attachments, "Link" to
            include attachments by reference to external files, or "Inline" to include attachments as
            inline content within the formatted document.  Different formats use different
            default content dispositions.</description>
            </item>
            </list>
            </para>
            </summary>
        </member>
        <member name="M:Gallio.Reports.XsltReportFormatter.#ctor(System.String,System.String,System.IO.DirectoryInfo,System.String,System.String[])">
            <summary>
            Creates an XSLT report formatter.
            </summary>
            <param name="extension">The preferred extension without a '.'</param>
            <param name="contentType">The content type of the main report document.</param>
            <param name="resourceDirectory">The resource directory.</param>
            <param name="xsltPath">The path of the XSLT relative to the resource directory.</param>
            <param name="resourcePaths">The paths of the resources (such as images or CSS) to copy
            to the report directory relative to the resource directory.</param>
            <exception cref="T:System.ArgumentNullException">Thrown if any arguments are null.</exception>
        </member>
        <member name="M:Gallio.Reports.XsltReportFormatter.Format(Gallio.Runner.Reports.IReportWriter,Gallio.Runner.Reports.ReportFormatterOptions,Gallio.Runtime.ProgressMonitoring.IProgressMonitor)">
            <inheritdoc />
        </member>
        <member name="M:Gallio.Reports.XsltReportFormatter.ApplyTransform(Gallio.Runner.Reports.IReportWriter,Gallio.Common.Markup.AttachmentContentDisposition,Gallio.Runner.Reports.ReportFormatterOptions)">
            <summary>
            Applies the transform to produce a report.
            </summary>
        </member>
        <member name="M:Gallio.Reports.XsltReportFormatter.CopyResources(Gallio.Runner.Reports.IReportWriter)">
            <summary>
            Copies additional resources to the content path within the report.
            </summary>
        </member>
        <member name="M:Gallio.Reports.XsltReportFormatter.PopulateArguments(System.Xml.Xsl.XsltArgumentList,Gallio.Runner.Reports.ReportFormatterOptions,System.String)">
            <summary>
            Populates the arguments for the XSL template processing.
            </summary>
        </member>
        <member name="M:Gallio.Reports.XsltReportFormatter.LoadTransform(System.String)">
            <summary>
            Loads the XSL transform.
            </summary>
            <param name="resolvedXsltPath">The full path of the XSLT.</param>
            <returns>The transform.</returns>
        </member>
        <member name="P:Gallio.Reports.XsltReportFormatter.Transform">
            <summary>
            Gets the XSL transform.
            </summary>
        </member>
    </members>
</doc>