FormatCustomCommand Class

Definition

Namespace:

Microsoft.PowerShell.Commands

Assembly:

Microsoft.PowerShell.Commands.Utility.dll

Package:

Microsoft.PowerShell.Commands.Utility v7.4.0

Implementation for the Format-Custom command. It just calls the formatting engine on complex shape.

public ref class FormatCustomCommand : Microsoft::PowerShell::Commands::Internal::Format::OuterFormatShapeCommandBase

[System.Management.Automation.Cmdlet("Format", "Custom", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096929")]
[System.Management.Automation.OutputType(new System.Type[] { typeof(Microsoft.PowerShell.Commands.Internal.Format.FormatStartData), typeof(Microsoft.PowerShell.Commands.Internal.Format.FormatEntryData), typeof(Microsoft.PowerShell.Commands.Internal.Format.FormatEndData), typeof(Microsoft.PowerShell.Commands.Internal.Format.GroupStartData), typeof(Microsoft.PowerShell.Commands.Internal.Format.GroupEndData) })]
public class FormatCustomCommand : Microsoft.PowerShell.Commands.Internal.Format.OuterFormatShapeCommandBase

[<System.Management.Automation.Cmdlet("Format", "Custom", HelpUri="https://go.microsoft.com/fwlink/?LinkID=2096929")>]
[<System.Management.Automation.OutputType(new System.Type[] { typeof(Microsoft.PowerShell.Commands.Internal.Format.FormatStartData), typeof(Microsoft.PowerShell.Commands.Internal.Format.FormatEntryData), typeof(Microsoft.PowerShell.Commands.Internal.Format.FormatEndData), typeof(Microsoft.PowerShell.Commands.Internal.Format.GroupStartData), typeof(Microsoft.PowerShell.Commands.Internal.Format.GroupEndData) })>]
type FormatCustomCommand = class
    inherit OuterFormatShapeCommandBase

Public Class FormatCustomCommand
Inherits OuterFormatShapeCommandBase

Inheritance

Object

InternalCommand

Cmdlet

PSCmdlet

FrontEndCommandBase

OuterFormatShapeCommandBase

FormatCustomCommand

Attributes

CmdletAttribute OutputTypeAttribute

Constructors

FormatCustomCommand()

Initializes a new instance of the FormatCustomCommand class and sets the inner command.

Properties

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)
CurrentPSTransaction	Gets an object that surfaces the current PowerShell transaction. When this object is disposed, PowerShell resets the active transaction. (Inherited from Cmdlet)
Depth
DisplayError	Optional, non positional parameter. (Inherited from OuterFormatShapeCommandBase)
Events	Gets the event manager for the current runspace. (Inherited from PSCmdlet)
Expand	Optional, non positional parameter. (Inherited from OuterFormatShapeCommandBase)
Force	Optional, non positional parameter. (Inherited from OuterFormatShapeCommandBase)
GroupBy	Optional, non positional parameter to specify the group by property. (Inherited from OuterFormatShapeCommandBase)
Host	Gets the host interaction APIs. (Inherited from PSCmdlet)
InputObject	This parameter specifies the current pipeline object. (Inherited from FrontEndCommandBase)
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)
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)
Property	Positional parameter for properties, property sets and table sets. specified on the command line. The parameter is optional, since the defaults will be determined using property sets, etc.
SessionState	Gets the instance of session state for the current runspace. (Inherited from PSCmdlet)
ShowError	Optional, non positional parameter. (Inherited from OuterFormatShapeCommandBase)
Stopping	Is this command stopping? (Inherited from Cmdlet)
View	Optional, non positional parameter. (Inherited from OuterFormatShapeCommandBase)

Methods

BeginProcessing()	(Inherited from OuterFormatShapeCommandBase)
CurrentProviderLocation(String)	(Inherited from PSCmdlet)
Dispose()	Default implementation just delegates to internal helper. (Inherited from FrontEndCommandBase)
Dispose(Boolean)	Dispose pattern implementation. (Inherited from FrontEndCommandBase)
EndProcessing()	Call the implementation. (Inherited from FrontEndCommandBase)
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, Object)	(Inherited from PSCmdlet)
GetVariableValue(String)	(Inherited from PSCmdlet)
InputObjectCall()	Callback for the implementation to get the current pipeline object. (Inherited from FrontEndCommandBase)
InternalDispose()	Do-nothing implementation: derived classes will override as see fit. (Inherited from FrontEndCommandBase)
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)
OuterCmdletCall()	Callback for the implementation to obtain a reference to the Cmdlet object. (Inherited from FrontEndCommandBase)
ProcessRecord()	Call the implementation. (Inherited from FrontEndCommandBase)
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)
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)	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)
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)
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)	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)	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)
StopProcessing()	Call the implementation. (Inherited from FrontEndCommandBase)
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, 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)
WriteObject(Object)	Writes the object to the output pipe. (Inherited from Cmdlet)
WriteObjectCall(Object)	Callback for the implementation to write objects. (Inherited from FrontEndCommandBase)
WriteProgress(ProgressRecord)	Display progress information. (Inherited from Cmdlet)
WriteVerbose(String)	Display verbose information. (Inherited from Cmdlet)
WriteWarning(String)	Display warning information. (Inherited from Cmdlet)