Skip to content

Set-OfficeExcelFreeze.md

Latest commit

 

History

History
137 lines (105 loc) · 2.56 KB

Set-OfficeExcelFreeze.md

File metadata and controls

137 lines (105 loc) · 2.56 KB
external help file PSWriteOffice-help.xml
Module Name PSWriteOffice
online version https://github.com/EvotecIT/PSWriteOffice
schema 2.0.0

Set-OfficeExcelFreeze

SYNOPSIS

Freezes panes on the current worksheet.

SYNTAX

Context (Default)

Set-OfficeExcelFreeze [-TopRows <int>] [-LeftColumns <int>] [<CommonParameters>]

Document

Set-OfficeExcelFreeze -Document <ExcelDocument> [-Sheet <string>] [-SheetIndex <int>] [-TopRows <int>] [-LeftColumns <int>] [<CommonParameters>]

DESCRIPTION

Freezes panes on the current worksheet.

EXAMPLES

EXAMPLE 1

PS>ExcelSheet 'Data' { Set-OfficeExcelFreeze -TopRows 1 }

Freezes the first row.

EXAMPLE 2

PS>ExcelSheet 'Data' { Set-OfficeExcelFreeze -TopRows 1 -LeftColumns 1 }

Freezes row 1 and column A.

PARAMETERS

-Document

Workbook to operate on outside the DSL context.

Type: ExcelDocument
Parameter Sets: Document
Aliases: None
Possible values: 

Required: True
Position: named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: True

-LeftColumns

Number of columns to freeze from the left.

Type: Int32
Parameter Sets: Context, Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-Sheet

Worksheet name when using Document.

Type: String
Parameter Sets: Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-SheetIndex

Worksheet index (0-based) when using Document.

Type: Nullable`1
Parameter Sets: Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

-TopRows

Number of rows to freeze from the top.

Type: Int32
Parameter Sets: Context, Document
Aliases: None
Possible values: 

Required: False
Position: named
Default value: None
Accept pipeline input: False
Accept wildcard characters: True

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

  • OfficeIMO.Excel.ExcelDocument

OUTPUTS

  • System.Object

RELATED LINKS

  • None