ConvertToHtmlCommand Class

Definition

Class comment.

public ref class ConvertToHtmlCommand sealed : System::Management::Automation::PSCmdlet
public sealed class ConvertToHtmlCommand : System.Management.Automation.PSCmdlet
[System.Management.Automation.Cmdlet("ConvertTo", "Html", DefaultParameterSetName="Page", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096595", RemotingCapability=System.Management.Automation.RemotingCapability.None)]
public sealed class ConvertToHtmlCommand : System.Management.Automation.PSCmdlet
[System.Management.Automation.Cmdlet("ConvertTo", "Html", DefaultParameterSetName="Page", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096595", RemotingCapability=System.Management.Automation.RemotingCapability.None)]
[System.Management.Automation.OutputType(typeof(System.String))]
public sealed class ConvertToHtmlCommand : System.Management.Automation.PSCmdlet
[System.Management.Automation.Cmdlet("ConvertTo", "Html", DefaultParameterSetName="Page", HelpUri="https://go.microsoft.com/fwlink/?LinkID=113290", RemotingCapability=System.Management.Automation.RemotingCapability.None)]
public sealed class ConvertToHtmlCommand : System.Management.Automation.PSCmdlet
type ConvertToHtmlCommand = class
    inherit PSCmdlet
[<System.Management.Automation.Cmdlet("ConvertTo", "Html", DefaultParameterSetName="Page", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096595", RemotingCapability=System.Management.Automation.RemotingCapability.None)>]
type ConvertToHtmlCommand = class
    inherit PSCmdlet
[<System.Management.Automation.Cmdlet("ConvertTo", "Html", DefaultParameterSetName="Page", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096595", RemotingCapability=System.Management.Automation.RemotingCapability.None)>]
[<System.Management.Automation.OutputType(typeof(System.String))>]
type ConvertToHtmlCommand = class
    inherit PSCmdlet
[<System.Management.Automation.Cmdlet("ConvertTo", "Html", DefaultParameterSetName="Page", HelpUri="https://go.microsoft.com/fwlink/?LinkID=113290", RemotingCapability=System.Management.Automation.RemotingCapability.None)>]
type ConvertToHtmlCommand = class
    inherit PSCmdlet
Public NotInheritable Class ConvertToHtmlCommand
Inherits PSCmdlet
Inheritance
ConvertToHtmlCommand
Attributes

Constructors

ConvertToHtmlCommand()

Properties

As

This specifies whether the objects should be rendered as an HTML TABLE or HTML LIST.

Body

Text to go after the opening body tag and before the table.

Charset

Specifies the charset encoding for the HTML document.

CommandOrigin

This property tells you if you were being invoked inside the runspace or if it was an external request.

(Inherited from InternalCommand)
CommandRuntime

Holds the command runtime object for this command. This object controls what actually happens when a write is called.

(Inherited from Cmdlet)
CssUri

This specifies a full or partial URI for the CSS information. The HTML should reference the CSS file specified.

CurrentPSTransaction

Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction.

(Inherited from Cmdlet)
Events

Gets the event manager for the current runspace.

(Inherited from PSCmdlet)
Fragment

When this switch is specified generate only the HTML representation of the incoming object without the HTML,HEAD,TITLE,BODY,etc tags.

Head

Text to go into the head section of the html doc.

Host

Gets the host interaction APIs.

(Inherited from PSCmdlet)
InputObject

The incoming object

InvokeCommand

Provides access to utility routines for executing scripts and creating script blocks.

(Inherited from PSCmdlet)
InvokeProvider

Gets the instance of the provider interface APIs for the current runspace.

(Inherited from PSCmdlet)
JobManager

Manager for JobSourceAdapters registered.

(Inherited from PSCmdlet)
JobRepository

Repository for jobs.

(Inherited from PSCmdlet)
Meta

Sets and Gets the meta property of the HTML head.

MyInvocation

Contains information about the identity of this cmdlet and how it was invoked.

(Inherited from PSCmdlet)
PagingParameters

If the cmdlet declares paging support (via SupportsPaging), then PagingParameters property contains arguments of the paging parameters. Otherwise PagingParameters property is null.

(Inherited from PSCmdlet)
ParameterSetName

The name of the parameter set in effect.

(Inherited from PSCmdlet)
PostContent

Specifies the text to include prior the closing body tag of the HTML output.

PreContent

Specifies the text to include after the body tag of the HTML output.

Property

The list of properties to display. These take the form of a PSPropertyExpression.

SessionState

Gets the instance of session state for the current runspace.

(Inherited from PSCmdlet)
Stopping

Is this command stopping?

(Inherited from Cmdlet)
Title

The string for the title tag The title is also placed in the body of the document before the table between h3 tags If the -Head parameter is used, this parameter has no effect.

Transitional

When this switch statement is specified, it will change the DOCTYPE to XHTML Transitional DTD.

Methods

BeginProcessing()

When overridden in the derived class, performs initialization of command execution. Default implementation in the base class just returns.

(Inherited from Cmdlet)
CurrentProviderLocation(String) (Inherited from PSCmdlet)
EndProcessing()

When overridden in the derived class, performs clean-up after the command execution. Default implementation in the base class just returns.

(Inherited from Cmdlet)
GetResolvedProviderPathFromPSPath(String, ProviderInfo) (Inherited from PSCmdlet)
GetResourceString(String, String)

Gets the resource string corresponding to baseName and resourceId from the current assembly. You should override this if you require a different behavior.

(Inherited from Cmdlet)
GetUnresolvedProviderPathFromPSPath(String) (Inherited from PSCmdlet)
GetVariableValue(String) (Inherited from PSCmdlet)
GetVariableValue(String, Object) (Inherited from PSCmdlet)
Invoke()

Invoke this cmdlet object returning a collection of results.

(Inherited from Cmdlet)
Invoke<T>()

Returns a strongly-typed enumerator for the results of this cmdlet.

(Inherited from Cmdlet)
ProcessRecord()

When overridden in the derived class, performs execution of the command.

(Inherited from Cmdlet)
ShouldContinue(String, String)

Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant only offers Yes/No, not YesToAll/NoToAll.

(Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean)

Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll.

(Inherited from Cmdlet)
ShouldContinue(String, String, Boolean, Boolean, Boolean)

Confirm an operation or grouping of operations with the user. This differs from ShouldProcess in that it is not affected by preference settings or command-line parameters, it always does the query. This variant offers Yes, No, YesToAll and NoToAll.

(Inherited from Cmdlet)
ShouldProcess(String)

Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed.

(Inherited from Cmdlet)
ShouldProcess(String, String)

Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed.

This variant allows the caller to specify text for both the target resource and the action.

(Inherited from Cmdlet)
ShouldProcess(String, String, String)

Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed.

This variant allows the caller to specify the complete text describing the operation, rather than just the name and action.

(Inherited from Cmdlet)
ShouldProcess(String, String, String, ShouldProcessReason)

Confirm the operation with the user. Cmdlets which make changes (e.g. delete files, stop services etc.) should call ShouldProcess to give the user the opportunity to confirm that the operation should actually be performed.

This variant allows the caller to specify the complete text describing the operation, rather than just the name and action.

(Inherited from Cmdlet)
StopProcessing()

When overridden in the derived class, interrupts currently running code within the command. It should interrupt BeginProcessing, ProcessRecord, and EndProcessing. Default implementation in the base class just returns.

(Inherited from Cmdlet)
ThrowTerminatingError(ErrorRecord)

Terminate the command and report an error.

(Inherited from Cmdlet)
TransactionAvailable()

Returns true if a transaction is available and active.

(Inherited from Cmdlet)
WriteCommandDetail(String)

Write text into pipeline execution log.

(Inherited from Cmdlet)
WriteDebug(String)

Display debug information.

(Inherited from Cmdlet)
WriteError(ErrorRecord)

Internal variant: Writes the specified error to the error pipe.

(Inherited from Cmdlet)
WriteInformation(InformationRecord)

Route information to the user or host.

(Inherited from Cmdlet)
WriteInformation(Object, String[])

Route information to the user or host.

(Inherited from Cmdlet)
WriteObject(Object)

Writes the object to the output pipe.

(Inherited from Cmdlet)
WriteObject(Object, Boolean)

Writes one or more objects to the output pipe. If the object is a collection and the enumerateCollection flag is true, the objects in the collection will be written individually.

(Inherited from Cmdlet)
WriteProgress(ProgressRecord)

Display progress information.

(Inherited from Cmdlet)
WriteVerbose(String)

Display verbose information.

(Inherited from Cmdlet)
WriteWarning(String)

Display warning information.

(Inherited from Cmdlet)

Applies to