Skip to content

Latest commit

 

History

History
158 lines (117 loc) · 5.55 KB

Write-TypeView.md

File metadata and controls

158 lines (117 loc) · 5.55 KB
Raw

Write-TypeView

Synopsis

Writes extended type view information

Description

PowerShell has a robust, extensible types system. With Write-TypeView, you can easily add extended type information to any type. This can include: The default set of properties to display (-DefaultDisplay) Sets of properties to display (-PropertySet) Serialization Depth (-SerializationDepth) Virtual methods or properties to add onto the type (-ScriptMethod, -ScriptProperty and -NoteProperty) Method or property aliasing (-AliasProperty)

Related Links

Parameters

TypeName

The name of the type. Multiple type names will all have the same methods, properties, events, etc.

Type Required Position PipelineInput
[String[]] true 1 true (ByPropertyName)

ScriptMethod

A collection of virtual method names and the script blocks that will be used to run the virtual method.

Type Required Position PipelineInput
[IDictionary] false named false

ScriptProperty

A Collection of virtual property names and the script blocks that will be used to get the property values.

Type Required Position PipelineInput
[IDictionary] false named false

NoteProperty

A collection of fixed property values.

Type Required Position PipelineInput
[IDictionary] false named false

AliasProperty

A collection of property aliases

Type Required Position PipelineInput
[IDictionary] false named false

EventGenerator

A collection of scripts that may create events. These will become ScriptMethods.

  • Send_NameOfEvent will call the generator and optionally send an event. Arguments will may be passed along to the event.
  • Register_NameOfEvent({}) will call Register-EngineEvent to register an event handler
  • Unregister_NameOfEvent([[PSEventSubscriber]) will call Unregister-EngineEvent to remove the handler.
Type Required Position PipelineInput
[IDictionary] false named false

EventName

A list of event names. These will become ScriptMethods.

  • Send_NameOfEvent will call the generator and optionally send an event. Arguments will be sent as event and message data.
  • Register_NameOfEvent({}) will call Register-EngineEvent to register an event handler
  • Unregister_NameOfEvent([[PSEventSubscriber]) will call Unregister-EngineEvent to remove the handler.
Type Required Position PipelineInput
[String[]] false named false

DefaultDisplay

The default display. If only one propertry is used, this will set the default display property. If more than one property is used, this will set the default display member set.

Type Required Position PipelineInput
[String[]] false named false

IdProperty

The ID property

Type Required Position PipelineInput
[String] false named false

SerializationDepth

The serialization depth. Serialization depth can be used to minimize the overhead of objects. If the type is deserialized, this is the depth of subpropeties that will be stored. For instance, a serialization depth of 3 would store:

  • an object,
  • it's subproperties
  • those objects' subproperties

The default serialization depth is 2.

Type Required Position PipelineInput
[Int32] false named false

Reserializer

The reserializer type used for recreating a deserialized type. If none is provided, consider using -Deserialized

Type Required Position PipelineInput
[Type] false named false

PropertySet

Property sets define default views for an object. A property set can be used with Select-Object to display just that set of properties.

Type Required Position PipelineInput
[IDictionary] false named false

HideProperty

If provided, will hide any properties in the list from automatically being displayed.

Type Required Position PipelineInput
[String[]] false named false

Deserialized

If set, will generate an identical typeview for the deserialized form of each typename.

Type Required Position PipelineInput
[Switch] false named false

Outputs

Syntax

Write-TypeView [-TypeName] <String[]> [-ScriptMethod <IDictionary>] [-ScriptProperty <IDictionary>] [-NoteProperty <IDictionary>] [-AliasProperty <IDictionary>] [-EventGenerator <IDictionary>] [-EventName <String[]>] [-DefaultDisplay <String[]>] [-IdProperty <String>] [-SerializationDepth <Int32>] [-Reserializer <Type>] [-PropertySet <IDictionary>] [-HideProperty <String[]>] [-Deserialized] [<CommonParameters>]