NetAppDocs PowerShell Module

Update-NtapDocument


NAME
    Update-NtapDocument

SYNOPSIS
    Used to update an existing Word or Excel document generated by the Out-NtapDocument function.


SYNTAX
    Update-NtapDocument [-InputFile] <Object> [-VisioFile <String>] [-SaveWordDocAsPdf] [-CustomerName <String>]
    [-CustomerLocation <String>] [-ProjectName <String>] [-AuthorName <String>] [<CommonParameters>]


DESCRIPTION
    Used to update an existing Word or Excel document generated by the Out-NtapDocument function. Updates
    the CustomerName and CustomerLocation properties (on the title page). For Word documents, this can add
    existing Visio drawings, update the Table of Contents and save as a PDF file.


PARAMETERS
    -InputFile <Object>
        Path to the Word or Excel document.

        Required?                    true
        Position?                    1
        Default value
        Accept pipeline input?       true (ByValue)
        Accept wildcard characters?  false

    -VisioFile <String>
        Path to an existing Visio document to copy the drawings from. (Word only)

        Required?                    false
        Position?                    named
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -SaveWordDocAsPdf [<SwitchParameter>]
        If specified, the Word document will also be saved as a PDF file.

        Required?                    false
        Position?                    named
        Default value                False
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -CustomerName <String>
        The customer name to add to the documentation.

        Required?                    false
        Position?                    named
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -CustomerLocation <String>
        The customer location to add to the documentation.

        Required?                    false
        Position?                    named
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -ProjectName <String>
        The project name to add to the documentation.

        Required?                    false
        Position?                    named
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?  false

    -AuthorName <String>
        The author name to add to the documentation.

        Required?                    false
        Position?                    named
        Default value
        Accept pipeline input?       false
        Accept wildcard characters?  false

    <CommonParameters>
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see
        about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS
    System.IO.FileInfo


OUTPUTS
    None


NOTES


        AUTHOR : Jason Cole

    -------------------------- EXAMPLE 1 --------------------------

    PS>Update-NtapDocument -InputFile 'D:\Output\SiteBuild.docx' -CustomerName 'Customer Name' -CustomerLocation 'Customer
    Location'

    Adds the CustomerName and CustomerLocation property to the specified Word file and updates the Table of Contents.




    -------------------------- EXAMPLE 2 --------------------------

    PS>Update-NtapDocument -InputFile 'D:\Output\SiteBuild.xlsx' -CustomerName 'Customer Name' -CustomerLocation 'Customer
    Location'

    Adds the CustomerName and CustomerLocation property to the specified Excel file.




    -------------------------- EXAMPLE 3 --------------------------

    PS>Update-NtapDocument -InputFile 'D:\Output\SiteBuild.docx' -VisioFile 'D:\Output\SiteDrawings.vsd'

    Copies the drawings from the specified Visio document into the Word document and updates the Table of Contents.




    -------------------------- EXAMPLE 4 --------------------------

    PS>Get-ChildItem -Path 'D:\Output\SiteBuild.docx' | Update-NtapDocument -VisioFile 'D:\Output\SiteDrawings.vsd'
    -SaveWordDocAsPdf

    Copies the drawings from the specified Visio document into the Word document and updates the Table of Contents. This document
    will also be saved as a PDF file.





RELATED LINKS
    https://community.netapp.com/t5/NetAppDocs/bd-p/netappdocs
    Out-NtapDocument