Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

FieldDescription Class

 

Updated: April 27, 2016

Applies To: Windows PowerShell

Represents an option that is used in a Windows PowerShell prompt call.

Namespace:   System.Management.Automation.Host
Assembly:  System.Management.Automation (in System.Management.Automation.dll)

System.Object
  System.Management.Automation.Host.FieldDescription

public class FieldDescription

NameDescription
System_CAPS_pubmethodFieldDescription(String)

Initializes a new instance of the FieldDescription class that contains the name of the option.

NameDescription
System_CAPS_pubpropertyAttributes

Gets the attributes that can be used to declare metadata for the option.

System_CAPS_pubpropertyDefaultValue

Gets or sets the default value for the option.

System_CAPS_pubpropertyHelpMessage

Gets or sets the Help message for the option.

System_CAPS_pubpropertyIsMandatory

Gets or sets a value that indicates whether the option is treated as a mandatory parameter.

System_CAPS_pubpropertyLabel

Gets or sets the label used to identify the option.

System_CAPS_pubpropertyName

Gets the name of the option.

System_CAPS_pubpropertyParameterAssemblyFullName

Gets the fully qualified name of the assembly containing the option's type.

System_CAPS_pubpropertyParameterTypeFullName

Gets the fully qualified name of the option's type.

System_CAPS_pubpropertyParameterTypeName

Gets the unqualified name of the option's type.

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFinalize()

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

(Inherited from Object.)

System_CAPS_pubmethodSetParameterType(Type)

Sets the type names for the ParameterTypeName and ParameterTypeFullName properties, and sets the assembly name for the ParameterAssemblyFullName property in a single operation.

System_CAPS_pubmethodToString()

(Inherited from Object.)

Prompt calls are made using the Prompt method.

It is permitted to derive from this class. However, there is no established scenario for doing this, nor has deriving from the class been tested.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: