Skip to content

Latest commit

 

History

History
400 lines (314 loc) · 7.18 KB

File metadata and controls

400 lines (314 loc) · 7.18 KB
external help file SPClientCore.dll-Help.xml
Module Name SPClientCore
online version
schema 2.0.0

Update-KshColumnDateTime

SYNOPSIS

Updates a column of date/time type.

SYNTAX

Update-KshColumnDateTime [-Identity] <Column> [-CalendarType <CalendarType>] [-ClientSideComponentId <String>]
 [-ClientSideComponentProperties <String>] [-CustomFormatter <String>] [-DateFormat <ColumnDateTimeFormatType>]
 [-DefaultFormula <String>] [-DefaultValue <String>] [-Description <String>] [-Direction <String>]
 [-EnforceUniqueValues <Boolean>] [-FriendlyFormat <ColumnDateTimeFriendlyFormatType>] [-Group <String>]
 [-Hidden <Boolean>] [-Indexed <Boolean>] [-JSLink <String>] [-NoCrawl <Boolean>] [-ReadOnly <Boolean>]
 [-Required <Boolean>] [-StaticName <String>] [-Title <String>] [-PushChanges] [-PassThru] [<CommonParameters>]

DESCRIPTION

The Update-KshColumnDateTime cmdlet updates properties of the column of date/time type.

EXAMPLES

Example 1

PS C:\> Update-KshColumnDateTime -Identity (Get-KshColumn -ColumnId '35aa78a6-66d7-472c-ab6b-d534193842af') -ReadOnly $true

Updates property values of the column.

PARAMETERS

-CalendarType

Specifies the calendar type.

Type: CalendarType
Parameter Sets: (All)
Aliases:
Accepted values: None, Gregorian, Japan, Taiwan, Korea, Hijri, Thai, Hebrew, GregorianMEFrench, GregorianArabic, GregorianXLITEnglish, GregorianXLITFrench, KoreaJapanLunar, ChineseLunar, SakaEra, UmAlQura

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

-ClientSideComponentId

Specifies the ID of the client-side component.

Type: String
Parameter Sets: (All)
Aliases:

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

-ClientSideComponentProperties

Specifies the JSON string that the propeties of the client-side component.

Type: String
Parameter Sets: (All)
Aliases:

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

-CustomFormatter

Specifies the JSON string of custom format.

Type: String
Parameter Sets: (All)
Aliases:

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

-DateFormat

Specifies the date/time format.

Type: ColumnDateTimeFormatType
Parameter Sets: (All)
Aliases:
Accepted values: DateOnly, DateTime

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

-DefaultFormula

Specifies the default formula.

Type: String
Parameter Sets: (All)
Aliases:

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

-DefaultValue

Specifies the default value.

Type: String
Parameter Sets: (All)
Aliases:

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

-Description

Specifies the description.

Type: String
Parameter Sets: (All)
Aliases:

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

-Direction

Specifies the direction.

Type: String
Parameter Sets: (All)
Aliases:

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

-EnforceUniqueValues

Specifies whether the column must to have unique value.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-FriendlyFormat

Specifies the friendly format.

Type: ColumnDateTimeFriendlyFormatType
Parameter Sets: (All)
Aliases:
Accepted values: Unspecified, Disabled, Relative

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

-Group

Specifies the name for grouping.

Type: String
Parameter Sets: (All)
Aliases:

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

-Hidden

Specifies whether to hide the column from users.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-Identity

Specifies the column.

Type: Column
Parameter Sets: (All)
Aliases:

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

-Indexed

Specifies whether to the column is indexed.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-JSLink

Specifies the JSLink URL.

Type: String
Parameter Sets: (All)
Aliases:

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

-NoCrawl

Specifies whether to suppress to search crawling.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-PassThru

If specified, returns the updated object.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-PushChanges

If Specified, propagates changes to all lists that use the column.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-ReadOnly

Specifies whether changes to the column properties are denied.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-Required

Specifies whether a value is required.

Type: Boolean
Parameter Sets: (All)
Aliases:

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

-StaticName

Specifies the static name.

Type: String
Parameter Sets: (All)
Aliases:

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

-Title

Specifies the title.

Type: String
Parameter Sets: (All)
Aliases:

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

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

Karamem0.SharePoint.PowerShell.Models.Column

OUTPUTS

Karamem0.SharePoint.PowerShell.Models.ColumnDateTime

NOTES

RELATED LINKS