Adding methods with ScriptMethod in PowerShell

Introduction

You add methods to objects to give them new actions they can do, making your scripts more powerful and organized.

When you want to add a custom action to an existing object without creating a new class.

When you need to reuse a small piece of code as a method on multiple objects.

When you want to extend built-in objects with your own functions for easier scripting.

When you want to keep your script clean by grouping related code inside objects.

Syntax

PowerShell

$object | Add-Member -MemberType ScriptMethod -Name MethodName -Value { param() <script block> }

Use Add-Member to add a ScriptMethod to an existing object.

The script block defines what the method does when called.

Examples

Adds a method SayHello that returns a greeting string.

PowerShell

$obj = New-Object PSObject
$obj | Add-Member -MemberType ScriptMethod -Name SayHello -Value { "Hello, world!" }
$obj.SayHello()

Adds a method AddNumbers that takes two numbers and returns their sum.

PowerShell

$obj = New-Object PSObject
$obj | Add-Member -MemberType ScriptMethod -Name AddNumbers -Value { param($a, $b) $a + $b }
$obj.AddNumbers(5, 7)

Sample Program

Creates a person object with a Name property and adds a Greet method that uses the Name to say hello.

PowerShell

$person = New-Object PSObject -Property @{ Name = 'Alice' }
$person | Add-Member -MemberType ScriptMethod -Name Greet -Value { "Hello, my name is $($this.Name)." }
Write-Output $person.Greet()

Important Notes

Inside the script block, use $this to refer to the object the method belongs to.

ScriptMethod lets you add behavior to objects without defining a full class.

You can add parameters to your ScriptMethod by using param() inside the script block.

Summary

Add-Member with ScriptMethod lets you add custom methods to objects.

Use $this inside the method to access the object's properties.

This helps organize code and reuse functionality easily.

Practice

1. What does the Add-Member -MemberType ScriptMethod cmdlet do in PowerShell?

easy

A. Deletes a property from an object

B. Adds a custom method (function) to an existing object

C. Creates a new object from scratch

D. Converts an object to a string

Solution

1. Step 1: Understand Add-Member usage

   Add-Member is used to add properties or methods to existing objects in PowerShell.

2. Step 2: Focus on ScriptMethod type

   When -MemberType ScriptMethod is used, it adds a method (a function) that can be called on the object.

3. Final Answer:

   Adds a custom method (function) to an existing object -> Option B

4. Quick Check:

   Add-Member ScriptMethod = Adds method [OK]

Hint: ScriptMethod adds functions to objects, not properties [OK]

Common Mistakes:

• Confusing ScriptMethod with adding properties
• Thinking it creates new objects
• Assuming it deletes object members

2. Which of the following is the correct syntax to add a ScriptMethod named Greet to an object $obj that returns 'Hello'?

easy

A. $obj | Add-Member -MemberType ScriptMethod -Name Greet -Value { 'Hello' }

B. Add-Member -InputObject $obj -MemberType ScriptProperty -Name Greet -Value { 'Hello' }

C. $obj.AddMember('Greet', { 'Hello' })

D. Add-Member -InputObject $obj -MemberType ScriptMethod -Name Greet -Value 'Hello'

Solution

1. Step 1: Identify correct Add-Member syntax

   The cmdlet requires piping the object or using -InputObject, specifying -MemberType ScriptMethod, -Name, and a script block for -Value.

2. Step 2: Check each option

   $obj | Add-Member -MemberType ScriptMethod -Name Greet -Value { 'Hello' } correctly pipes $obj and uses a script block { 'Hello' } as the method body. Add-Member -InputObject $obj -MemberType ScriptProperty -Name Greet -Value { 'Hello' } uses ScriptProperty, which is wrong. $obj.AddMember('Greet', { 'Hello' }) is invalid syntax. Add-Member -InputObject $obj -MemberType ScriptMethod -Name Greet -Value 'Hello' passes a string instead of a script block.

3. Final Answer:

   $obj | Add-Member -MemberType ScriptMethod -Name Greet -Value { 'Hello' } -> Option A

4. Quick Check:

   ScriptMethod needs script block value [OK]

Hint: Use a script block { } for ScriptMethod -Value [OK]

Common Mistakes:

• Using ScriptProperty instead of ScriptMethod
• Passing string instead of script block
• Wrong cmdlet syntax without piping or -InputObject

3. What will be the output of this PowerShell code?

$obj = New-Object PSObject -Property @{Name='Alice'}
$obj | Add-Member -MemberType ScriptMethod -Name SayName -Value { "My name is $($this.Name)" }
$obj.SayName()

medium

A. My name is

B. My name is $this.Name

C. My name is Alice

D. Error: Property 'Name' not found

Solution

1. Step 1: Understand object and method

   $obj has a property Name='Alice'. The ScriptMethod SayName uses $this.Name to access that property.

2. Step 2: Evaluate method call output

   Calling $obj.SayName() runs the script block, replacing $($this.Name) with 'Alice', so output is 'My name is Alice'.

3. Final Answer:

   My name is Alice -> Option C

4. Quick Check:

   $this.Name accesses property correctly [OK]

Hint: Use $this to access object properties inside ScriptMethod [OK]

Common Mistakes:

• Expecting literal $this.Name output
• Confusing property access syntax
• Thinking method won't access object properties

4. Identify the error in this code snippet that tries to add a ScriptMethod to $obj:

$obj = New-Object PSObject -Property @{Age=30}
Add-Member -InputObject $obj -MemberType ScriptMethod -Name GetAge -Value { return $Age }
$obj.GetAge()

medium

A. The property Age does not exist on $obj

B. Add-Member requires piping the object, not -InputObject

C. ScriptMethod cannot return values

D. The script block should use $this.Age to access the property

Solution

1. Step 1: Check property access inside ScriptMethod

   The script block uses $Age which is undefined in this scope. To access the object's property, use $this.Age.

2. Step 2: Verify other parts

   Using -InputObject is valid. ScriptMethod can return values. Property Age exists on $obj.

3. Final Answer:

   The script block should use $this.Age to access the property -> Option D

4. Quick Check:

   Use $this.Property inside ScriptMethod [OK]

Hint: Inside ScriptMethod, always use $this.Property to access object data [OK]

Common Mistakes:

• Using property name without $this inside script block
• Thinking piping is mandatory for Add-Member
• Assuming ScriptMethod can't return values

5. You want to add a ScriptMethod FullName to an object $person that has properties FirstName and LastName. The method should return the full name with a space between first and last names. Which code correctly implements this?

hard

A. $person | Add-Member -MemberType ScriptMethod -Name FullName -Value { "$($this.FirstName) $($this.LastName)" }

B. $person | Add-Member -MemberType ScriptProperty -Name FullName -Value { "$($this.FirstName) $($this.LastName)" }

C. $person | Add-Member -MemberType ScriptMethod -Name FullName -Value { $this.FirstName + $this.LastName }

D. $person | Add-Member -MemberType ScriptMethod -Name FullName -Value { return "$this.FirstName $this.LastName" }

Solution

1. Step 1: Confirm correct MemberType and method body

   The method must be a ScriptMethod, not ScriptProperty.

2. Step 2: Check string concatenation and property access

   $person | Add-Member -MemberType ScriptMethod -Name FullName -Value { "$($this.FirstName) $($this.LastName)" } uses string interpolation with $($this.FirstName) and $($this.LastName) separated by space, which correctly returns full name.

3. Step 3: Analyze other options

   $person | Add-Member -MemberType ScriptMethod -Name FullName -Value { $this.FirstName + $this.LastName } concatenates without space. $person | Add-Member -MemberType ScriptMethod -Name FullName -Value { return "$this.FirstName $this.LastName" } uses return but misses $() around variables, so variables won't expand properly.

4. Final Answer:

   $person | Add-Member -MemberType ScriptMethod -Name FullName -Value { "$($this.FirstName) $($this.LastName)" } -> Option A

5. Quick Check:

   Use string interpolation with $() for properties [OK]

Hint: Use "$($this.Prop) $($this.Prop)" for spaced string in ScriptMethod [OK]

Common Mistakes:

• Using ScriptProperty instead of ScriptMethod
• Concatenating strings without space
• Not using $() for property expansion inside strings