Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 700 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/
Cmdlet

Get-OfficeHiddenData

Module
PSWriteOffice
Inputs
System.String[]
Outputs
PSWriteOffice.Models.OfficeHiddenDataFileReport
Source
GetOfficeHiddenDataCommand.cs:24 Edit on GitHub

Reports the metadata and hidden data that would leave with a file. The file is never changed.

Syntax

Get-OfficeHiddenData
[-Path] <String[]>
[<CommonParameters>]
#
Parameter set: Path
Get-OfficeHiddenData
-LiteralPath <String[]>
[<CommonParameters>]
#
Parameter set: LiteralPath

Description

Finds author and company properties, comments, tracked changes, hidden text, rows, sheets and slides, speaker notes, image metadata such as GPS locations, scripts, attachments, Content Credentials and AI labels. Inputs are Word, Excel, PowerPoint, Visio, OpenDocument, EPUB, PDF, JPEG, PNG, WebP, GIF and TIFF files. Each finding has the Outcome Found.

Guides & Samples

Authored walkthroughs and practical samples linked to this command.

  • Clean Files Before Sharing Guide

    Remove comments, author names, speaker notes, image metadata and AI labels from Office, PDF and image files with PowerShell.

  • What PSWriteOffice Covers Guide

    A practical map of PSWriteOffice's manifest-derived commands, workflow families, OfficeIMO relationship, and supported automation outcomes.

  • Prepare a document for sharing Guide

    Remove author names, comments, hidden content and photo locations from Office, PDF and image files, and check AI labels and accessibility before you share.

  • Remove hidden data and metadata Guide

    Inspect and remove properties, comments, tracked changes, hidden content, notes, attachments, scripts and GPS data from Office, PDF, EPUB and image files.

Examples

List what would leave with a proposal.

(Get-OfficeHiddenData -Path .\Proposal.docx).Findings

Find the files in an outgoing folder that still carry comments or tracked changes.

Get-ChildItem .\Outgoing -File | Get-OfficeHiddenData |
                Where-Object { $_.Findings.Kind -contains 'Comments' -or $_.Findings.Kind -contains 'TrackedChanges' }

Parameters

-Path String[] requiredposition: 0pipeline: True (ByValue)sets: Path
Files to inspect; supports wildcards.
-LiteralPath String[] requiredpipeline: True (ByPropertyName)aliases: FullName, PSPathsets: LiteralPath
Exact file paths, including FileInfo.FullName and provider PSPath pipeline properties.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Outputs

PSWriteOffice.Models.OfficeHiddenDataFileReport: Hidden data found in one file, what removal did with each item, and where the cleaned copy was written.