Skip to content

Add-OfficeExcelValidationWholeNumber.md

Latest commit

 

History

History
226 lines (178 loc) · 4.29 KB

Add-OfficeExcelValidationWholeNumber.md

File metadata and controls

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

Add-OfficeExcelValidationWholeNumber

SYNOPSIS

Adds a whole-number data validation rule to a worksheet range.

SYNTAX

Context (Default)

Add-OfficeExcelValidationWholeNumber [-Range] <string> [-Operator] <string> [-Formula1] <int> [-Formula2 <int>] [-AllowBlank <bool>] [-ErrorTitle <string>] [-ErrorMessage <string>] [-PassThru] [<CommonParameters>]

Document

Add-OfficeExcelValidationWholeNumber [-Range] <string> [-Operator] <string> [-Formula1] <int> -Document <ExcelDocument> [-Sheet <string>] [-SheetIndex <int>] [-Formula2 <int>] [-AllowBlank <bool>] [-ErrorTitle <string>] [-ErrorMessage <string>] [-PassThru] [<CommonParameters>]

DESCRIPTION

Adds a whole-number data validation rule to a worksheet range.

EXAMPLES

EXAMPLE 1

PS>ExcelSheet 'Data' { Add-OfficeExcelValidationWholeNumber -Range 'B2:B20' -Operator Between -Formula1 1 -Formula2 10 }

Ensures values in B2:B20 are between 1 and 10.

PARAMETERS

-AllowBlank

Allow blank values.

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

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

-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

-ErrorMessage

Error message shown to the user.

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

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

-ErrorTitle

Error title shown to the user.

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

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

-Formula1

Primary numeric bound.

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

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

-Formula2

Optional secondary numeric bound.

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

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

-Operator

Validation operator.

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

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

-PassThru

Emit the range string after applying validation.

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

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

-Range

Target range in A1 notation.

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

Required: True
Position: 0
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

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