ArgumentTransformationAttribute Class

Reference

Definition

Namespace:: System.Management.Automation

Assembly:: System.Management.Automation.dll

Package:: Microsoft.PowerShell.5.1.ReferenceAssemblies v1.0.0

Package:: System.Management.Automation v7.0.13

Package:: System.Management.Automation v7.1.7

Package:: System.Management.Automation v7.2.12

Package:: System.Management.Automation v7.3.5

Package:: System.Management.Automation v7.4.0

Package:: Microsoft.WSMan.Runtime v6.1.0

Package:: Microsoft.WSMan.Runtime v6.2.0

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Serves as the base class for attributes that perform argument transformation.

public ref class ArgumentTransformationAttribute abstract : System::Management::Automation::Internal::CmdletMetadataAttribute

[System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property)]
public abstract class ArgumentTransformationAttribute : System.Management.Automation.Internal.CmdletMetadataAttribute

[<System.AttributeUsage(System.AttributeTargets.Field | System.AttributeTargets.Property)>]
type ArgumentTransformationAttribute = class
    inherit CmdletMetadataAttribute

Public MustInherit Class ArgumentTransformationAttribute
Inherits CmdletMetadataAttribute

Inheritance: Attribute

CmdletMetadataAttribute
ArgumentTransformationAttribute

Derived: Microsoft.PowerShell.DesiredStateConfiguration.ArgumentToConfigurationDataTransformationAttribute

System.Management.Automation.CredentialAttribute

System.Management.Automation.Runspaces.RunspaceAttribute

Attributes: AttributeUsageAttribute

Remarks

Argument transformation attributes can be attached to Cmdlet and CmdletProvider parameters to automatically transform the argument value in some fashion. The transformation might change the object, convert the type, or even load a file or AD object based on the name. Existing argument transformation attributes include System.Management.Automation.ArgumentTypeConverterAttribute. Custom argument transformation attributes should derive from ArgumentTransformationAttribute and override the Transform(EngineIntrinsics, Object) abstract method, after which they can apply the attribute to their parameters. It is also recommended to override ToString() to return a readable string similar to the attribute declaration, for example "[ValidateRangeAttribute(5,10)]". If multiple transformations are defined on a parameter, they will be invoked in series, each getting the output of the previous transformation.

Constructors

ArgumentTransformationAttribute()

Initializes a new instance of the ArgumentTransformationAttribute class.

Properties

TransformNullOptionalParameters

The property is only checked when: a) The parameter is not mandatory b) The argument is null.

Methods

Transform(EngineIntrinsics, Object)

Method that will be overridden by the subclasses to transform the inputData parameter argument into some other object that will be used for the parameter's value.

Applies to