PSStringTemplate

0.2.0

bin/Core/PSStringTemplate.xml

                                <?xml version="1.0"?>

<doc>

    <assembly>

        <name>PSStringTemplate</name>

    </assembly>

    <members>

        <member name="T:PSStringTemplate.AdapterUtil">

            <summary>

            Provides shared utility methods for adapters.

            </summary>

        </member>

        <member name="M:PSStringTemplate.AdapterUtil.NullIfEmpty(System.Object)">

            <summary>

            Filter empty adapter results to allow PowerShell-like

            treatment of objects as true or false.

            </summary>

            <param name="value">The value to filter.</param>

            <returns> Either <see langword="null"/> if empty or the value.</returns>

        </member>

        <member name="T:PSStringTemplate.ErrorListener">

            <summary>

            Intercepts errors generated by <see cref="T:Antlr4.StringTemplate.Template"/> objects and creates

            terminating error records that a PowerShell user would expect.

            </summary>

        </member>

        <member name="M:PSStringTemplate.ErrorListener.#ctor(System.Management.Automation.Cmdlet)">

            <summary>

            Initializes a new instance of the <see cref="T:PSStringTemplate.ErrorListener"/> class.

            </summary>

            <param name="terminatingErrorContext">The cmdlet invocation context to throw from.</param>

        </member>

        <member name="P:PSStringTemplate.ErrorListener.ErrorContext">

            <summary>

            Gets the cmdlet context to use so invocation messages are correct.

            </summary>

        </member>

        <member name="M:PSStringTemplate.ErrorListener.CompiletimeError(Antlr4.StringTemplate.Misc.TemplateMessage)">

            <summary>

            Handles errors at template compile time, typically related to parsing issues.

            </summary>

            <param name="msg">The message from Antlr.</param>

        </member>

        <member name="M:PSStringTemplate.ErrorListener.InternalError(Antlr4.StringTemplate.Misc.TemplateMessage)">

            <summary>

            Catch and rethrow unexpected internal errors.

            </summary>

            <param name="msg">The <see cref="T:Antlr4.StringTemplate.Misc.TemplateMessage"/> from Antlr.</param>

        </member>

        <member name="M:PSStringTemplate.ErrorListener.IOError(Antlr4.StringTemplate.Misc.TemplateMessage)">

            <summary>

            Catch and rethrow unexpected IO errors.

            </summary>

            <param name="msg">The <see cref="T:Antlr4.StringTemplate.Misc.TemplateMessage"/> from Antlr.</param>

        </member>

        <member name="M:PSStringTemplate.ErrorListener.RuntimeError(Antlr4.StringTemplate.Misc.TemplateMessage)">

            <summary>

            Handles errors thrown while a template is rendering.

            </summary>

            <param name="msg">The message from Antlr.</param>

        </member>

        <member name="M:PSStringTemplate.ErrorListener.ThrowUnhandledError(System.String,Antlr4.StringTemplate.Misc.TemplateMessage)">

            <summary>

            Throws a generate error record for any unanticipated exception.

            </summary>

            <param name="id">The ErrorId we want to show in the error record to help narrow down context.</param>

            <param name="msg">The message passed to the caller from Antlr.</param>

        </member>

        <member name="T:PSStringTemplate.InvokeStringTemplateCommand">

            <summary>

            The Invoke-StringTemplate cmdlet adds arguments to a template object

            (either existing or created by this cmdlet) and returns the rendered

            string.

            </summary>

        </member>

        <member name="P:PSStringTemplate.InvokeStringTemplateCommand.Definition">

            <summary>

            Gets or sets the string template definition to invoke.

            </summary>

        </member>

        <member name="P:PSStringTemplate.InvokeStringTemplateCommand.Group">

            <summary>

            Gets or sets the target template group.

            </summary>

        </member>

        <member name="P:PSStringTemplate.InvokeStringTemplateCommand.Name">

            <summary>

            Gets or sets the name of the template to invoke.

            </summary>

        </member>

        <member name="P:PSStringTemplate.InvokeStringTemplateCommand.Parameters">

            <summary>

            Gets or sets the template parameters.

            </summary>

        </member>

        <member name="M:PSStringTemplate.InvokeStringTemplateCommand.ProcessRecord">

            <summary>

            ProcessRecord method.

            </summary>

        </member>

        <member name="M:PSStringTemplate.InvokeStringTemplateCommand.ProcessObjectAsArguments">

            <summary>

            Get the properties of the object in the "Parameter" input parameter and add them as

            template arguments.

            </summary>

        </member>

        <member name="M:PSStringTemplate.InvokeStringTemplateCommand.AddTemplateArgument(System.String,System.Object)">

            <summary>

            Adds an argument to a template with extra exception handling.

            </summary>

            <param name="name">The parameter name.</param>

            <param name="value">The value to assign to the parameter.</param>

        </member>

        <member name="T:PSStringTemplate.MessageHelper">

            <summary>

            Helper class to get only the pieces of a TemplateMessage that we need to create

            an error record for PowerShell to consume.

            </summary>

        </member>

        <member name="M:PSStringTemplate.MessageHelper.#ctor(Antlr4.StringTemplate.Misc.TemplateMessage)">

            <summary>

            Initializes a new instance of the <see cref="T:PSStringTemplate.MessageHelper"/> class.

            </summary>

            <param name="msg">The message passed by Antlr.</param>

        </member>

        <member name="P:PSStringTemplate.MessageHelper.ErrorDescription">

            <summary>

            Gets the summary of the error from the <see cref="T:Antlr4.StringTemplate.Misc.TemplateMessage"/>.

            </summary>

        </member>

        <member name="P:PSStringTemplate.MessageHelper.ErrorExtent">

            <summary>

            Gets the approximate location of the invalid syntax.

            </summary>

        </member>

        <member name="T:PSStringTemplate.NewStringTemplateGroupCommand">

            <summary>

            The New-StringTemplateGroup cmdlet creates a <see cref="T:PSStringTemplate.TemplateGroupInfo"/> object

            from either a group or template definition string.

            </summary>

        </member>

        <member name="P:PSStringTemplate.NewStringTemplateGroupCommand.Definition">

            <summary>

            Gets or sets the string template group definition.

            </summary>

        </member>

        <member name="M:PSStringTemplate.NewStringTemplateGroupCommand.EndProcessing">

            <summary>

            EndProcessing method.

            </summary>

        </member>

        <member name="T:PSStringTemplate.Properties.Resources">

            <summary>

              A strongly-typed resource class, for looking up localized strings, etc.

            </summary>

        </member>

        <member name="P:PSStringTemplate.Properties.Resources.ResourceManager">

            <summary>

              Returns the cached ResourceManager instance used by this class.

            </summary>

        </member>

        <member name="P:PSStringTemplate.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="P:PSStringTemplate.Properties.Resources.CompiletimeExceptionWrapper">

            <summary>

              Looks up a localized string similar to Unable to compile template. Engine message: {0}.

            </summary>

        </member>

        <member name="P:PSStringTemplate.Properties.Resources.DebugArgumentNotFound">

            <summary>

              Looks up a localized string similar to Missing argument &apos;{0}&apos; in template &apos;{1}&apos;, skipping..

            </summary>

        </member>

        <member name="P:PSStringTemplate.Properties.Resources.DebugAttributeNotFound">

            <summary>

              Looks up a localized string similar to No matching attribute found for parameter &apos;{0}&apos; in template &apos;{1}&apos;..

            </summary>

        </member>

        <member name="P:PSStringTemplate.Properties.Resources.DebugInvokePropertyLikeMethodException">

            <summary>

              Looks up a localized string similar to An exception was received while invoking method &apos;{0}&apos; for attribute &apos;{1}&apos;..

            </summary>

        </member>

        <member name="P:PSStringTemplate.Properties.Resources.DebugPropertyNotFound">

            <summary>

              Looks up a localized string similar to Could not find property &apos;{0}&apos; while processing template &apos;{1}&apos;..

            </summary>

        </member>

        <member name="P:PSStringTemplate.Properties.Resources.DefaultTemplateName">

            <summary>

              Looks up a localized string similar to anonymous.

            </summary>

        </member>

        <member name="P:PSStringTemplate.Properties.Resources.RuntimeExceptionWrapper">

            <summary>

              Looks up a localized string similar to An exception occurred while processing template &quot;{0}&quot;.  Engine message: {1}.

            </summary>

        </member>

        <member name="P:PSStringTemplate.Properties.Resources.TemplateNotFound">

            <summary>

              Looks up a localized string similar to Cannot find template &apos;{0}&apos;. (Found: {1}).

            </summary>

        </member>

        <member name="P:PSStringTemplate.Properties.Resources.UnhandledErrorMessage">

            <summary>

              Looks up a localized string similar to Unhandled exception from StringTemplate, please file an issue on GitHub. Engine message: {0}.

            </summary>

        </member>

        <member name="P:PSStringTemplate.Properties.Resources.VerboseAddedParameter">

            <summary>

              Looks up a localized string similar to Added parameter &apos;{0}&apos; to template &apos;{1}&apos;..

            </summary>

        </member>

        <member name="T:PSStringTemplate.PSObjectAdaptor">

            <summary>

            Provides property binding for <see cref="T:System.Management.Automation.PSObject"/> objects.

            </summary>

        </member>

        <member name="M:PSStringTemplate.PSObjectAdaptor.GetProperty(Antlr4.StringTemplate.Interpreter,Antlr4.StringTemplate.TemplateFrame,System.Object,System.Object,System.String)">

            <summary>

            Gets the value of a property if it exists.

            </summary>

            <param name="interpreter">The current interpreter passed by Antlr.</param>

            <param name="frame">The current frame passed by Antlr.</param>

            <param name="obj">The target of the property binding</param>

            <param name="property">The property passed by Antlr.</param>

            <param name="propertyName">The target property name.</param>

            <returns>The value of the property if it exists, otherwise <see langword="null"/>.</returns>

        </member>

        <member name="T:PSStringTemplate.TemplateGroupInfo">

            <summary>

            Displays <see cref="T:Antlr4.StringTemplate.TemplateGroup"/> object information in a simpler format for use in PowerShell.

            </summary>

        </member>

        <member name="M:PSStringTemplate.TemplateGroupInfo.#ctor(Antlr4.StringTemplate.TemplateGroup)">

            <summary>

            Initializes a new instance of the <see cref="T:PSStringTemplate.TemplateGroupInfo"/> class.

            </summary>

            <param name="templateGroupInstance">The internal group instance.</param>

        </member>

        <member name="P:PSStringTemplate.TemplateGroupInfo.Templates">

            <summary>

            Gets the <see cref="T:Antlr4.StringTemplate.Template"/> objects that belong to this group, wrapped in

            <see cref="T:PSStringTemplate.TemplateInfo"/> objects.

            </summary>

        </member>

        <member name="P:PSStringTemplate.TemplateGroupInfo.Instance">

            <summary>

            Gets the base <see cref="T:Antlr4.StringTemplate.TemplateGroup"/> that this object wraps.

            </summary>

        </member>

        <member name="M:PSStringTemplate.TemplateGroupInfo.CreateFromTemplateDefinition(System.Management.Automation.Cmdlet,System.String)">

            <summary>

            Create a <see cref="T:Antlr4.StringTemplate.TemplateGroupString"/> from a template definition string.

            </summary>

            <param name="context">The error listener attached to the currently running cmdlet.</param>

            <param name="templateDefinition">The template source to use.</param>

            <returns>The defined template.</returns>

        </member>

        <member name="M:PSStringTemplate.TemplateGroupInfo.CreateFromGroupDefinition(System.Management.Automation.Cmdlet,System.String)">

            <summary>

            Create a template group from a string group definition.

            </summary>

            <param name="context">The <see cref="T:System.Management.Automation.Cmdlet"/> context to throw from.</param>

            <param name="groupDefinition">The string group definition.</param>

            <returns>The compiled template group.</returns>

        </member>

        <member name="M:PSStringTemplate.TemplateGroupInfo.Bind(System.Management.Automation.Cmdlet)">

            <summary>

            Attaches a template group to a running <see cref="T:System.Management.Automation.Cmdlet"/>.

            </summary>

            <param name="context">The <see cref="T:System.Management.Automation.Cmdlet"/> instance to attach to.</param>

        </member>

        <member name="M:PSStringTemplate.TemplateGroupInfo.Unbind">

            <summary>

            Removes the attached <see cref="T:System.Management.Automation.Cmdlet"/> from a template group.

            </summary>

        </member>

        <member name="M:PSStringTemplate.TemplateGroupInfo.Bind(Antlr4.StringTemplate.TemplateGroup,System.Management.Automation.Cmdlet)">

            <summary>

            Attaches a template group to a running <see cref="T:System.Management.Automation.Cmdlet"/>.

            </summary>

            <param name="group">The <see cref="T:Antlr4.StringTemplate.TemplateGroup"/> to attach.</param>

            <param name="context">The <see cref="T:System.Management.Automation.Cmdlet"/> instance to attach to.</param>

        </member>

        <member name="T:PSStringTemplate.TemplateInfo">

            <summary>

            Displays <see cref="T:Antlr4.StringTemplate.Template"/> information in a simpler format for use in PowerShell.

            </summary>

        </member>

        <member name="M:PSStringTemplate.TemplateInfo.#ctor(Antlr4.StringTemplate.Template,PSStringTemplate.TemplateGroupInfo)">

            <summary>

            Initializes a new instance of the <see cref="T:PSStringTemplate.TemplateInfo"/> class.

            </summary>

            <param name="templateInstance">The internal <see cref="T:Antlr4.StringTemplate.Template"/> object.</param>

            <param name="groupInfo">The group the template belongs to.</param>

        </member>

        <member name="P:PSStringTemplate.TemplateInfo.Parameters">

            <summary>

            Gets the parameters defined in the wrapped <see cref="T:Antlr4.StringTemplate.Template"/>.

            </summary>

        </member>

        <member name="P:PSStringTemplate.TemplateInfo.Name">

            <summary>

            Gets the name of the wrapped <see cref="T:Antlr4.StringTemplate.Template"/>.

            </summary>

        </member>

        <member name="P:PSStringTemplate.TemplateInfo.TemplateSource">

            <summary>

            Gets the raw <see cref="T:Antlr4.StringTemplate.Template"/> source string.

            </summary>

        </member>

        <member name="P:PSStringTemplate.TemplateInfo.Group">

            <summary>

            Gets the <see cref="T:Antlr4.StringTemplate.TemplateGroup"/> this template belongs to wrapped in a

            <see cref="T:PSStringTemplate.TemplateGroupInfo"/> object.

            </summary>

        </member>

        <member name="P:PSStringTemplate.TemplateInfo.Instance">

            <summary>

            Gets the base <see cref="T:Antlr4.StringTemplate.Template"/> object.

            </summary>

        </member>

        <member name="M:PSStringTemplate.TemplateInfo.ResetInstance">

            <summary>

            Recompile the wrapped <see cref="T:Antlr4.StringTemplate.Template"/> to clear arguments.

            </summary>

        </member>

        <member name="T:PSStringTemplate.TypeAdapter">

            <summary>

            Provides static property binding for <see cref="T:System.Type"/> objects.

            </summary>

        </member>

        <member name="M:PSStringTemplate.TypeAdapter.GetProperty(Antlr4.StringTemplate.Interpreter,Antlr4.StringTemplate.TemplateFrame,System.Object,System.Object,System.String)">

            <summary>

            Gets the value of a property if it exists.

            </summary>

            <param name="interpreter">The current interpreter passed by Antlr.</param>

            <param name="frame">The current frame passed by Antlr.</param>

            <param name="o">The target of the property binding</param>

            <param name="property">The property passed by Antlr.</param>

            <param name="propertyName">The target property name.</param>

            <returns>The value of the property if it exists, otherwise <see langword="null"/>.</returns>

        </member>

        <member name="M:PSStringTemplate.TypeAdapter.GetProperty(System.Type,System.String)">

            <summary>

            Gets the value of a static property.

            </summary>

            <param name="type">The <see cref="T:System.Type"/> with the target property.</param>

            <param name="propertyName">The name of the property to retrieve.</param>

            <returns>The value if the property exists, otherwise <see langword="null"/>.</returns>

        </member>

    </members>

</doc>