Adding methods with ScriptMethod in PowerShell - Mini Project: Build & Apply

Adding methods with ScriptMethod in PowerShell

📖 Scenario: You are managing a list of simple objects representing books in a library. Each book has a title and an author. You want to add a method to each book object that can display its details in a friendly format.

🎯 Goal: Learn how to add a method called ShowDetails to each book object using ScriptMethod. This method will print the book's title and author in a readable sentence.

📋 What You'll Learn

Create a list of book objects with Title and Author properties

Add a ScriptMethod called ShowDetails to each book object

The ShowDetails method should output a string like: 'Title: [Title], Author: [Author]'

Call the ShowDetails method for each book and display the output

💡 Why This Matters

🌍 Real World

Adding methods to objects dynamically is useful when working with data that needs custom behavior without creating full classes. For example, enhancing data from APIs or files.

💼 Career

PowerShell scripting with custom objects and methods is common in system administration and automation tasks, helping to organize and extend data processing.

1

Create the list of book objects

Create a variable called books that contains two custom objects. The first object should have Title set to 'The Hobbit' and Author set to 'J.R.R. Tolkien'. The second object should have Title set to '1984' and Author set to 'George Orwell'.

PowerShell

# Create the list of book objects with Title and Author properties
# Your code here

Hint

Use [PSCustomObject] to create each book with Title and Author properties inside an array.

2

Add the ScriptMethod to each book

Add a ScriptMethod called ShowDetails to each book object in $books. The method should return a string formatted as 'Title: [Title], Author: [Author]' using the object's properties.

PowerShell

$books = @(
    [PSCustomObject]@{ Title = 'The Hobbit'; Author = 'J.R.R. Tolkien' },
    [PSCustomObject]@{ Title = '1984'; Author = 'George Orwell' }
)

# Add ScriptMethod ShowDetails to each book
# Your code here

Hint

Use a foreach loop to add a PSScriptMethod named ShowDetails to each book's PSObject.Members.

3

Call the ShowDetails method for each book

Use a foreach loop to call the ShowDetails method on each book object in $books and store the results in a new list called details.

PowerShell

$books = @(
    [PSCustomObject]@{ Title = 'The Hobbit'; Author = 'J.R.R. Tolkien' },
    [PSCustomObject]@{ Title = '1984'; Author = 'George Orwell' }
)

foreach ($book in $books) {
    $book.PSObject.Members.Add(
        [System.Management.Automation.PSScriptMethod]::new('ShowDetails', { "Title: $($this.Title), Author: $($this.Author)" })
    )
}

# Call ShowDetails on each book and save results in $details
# Your code here

Hint

Use a foreach loop to call ShowDetails() on each book and collect the output in $details.

4

Display the details of all books

Print the contents of the $details list to show the formatted details of each book.

PowerShell

$books = @(
    [PSCustomObject]@{ Title = 'The Hobbit'; Author = 'J.R.R. Tolkien' },
    [PSCustomObject]@{ Title = '1984'; Author = 'George Orwell' }
)

foreach ($book in $books) {
    $book.PSObject.Members.Add(
        [System.Management.Automation.PSScriptMethod]::new('ShowDetails', { "Title: $($this.Title), Author: $($this.Author)" })
    )
}

$details = foreach ($book in $books) {
    $book.ShowDetails()
}

# Print the details list
# Your code here

Hint

Use Write-Output or Write-Host to print each string in $details.

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