New-UDDataGridColumn

Creates a new data grid column.

Synopsis

Creates a new data grid column.

Syntax

New-UDDataGridColumn [[-CellClassName] <String>] [[-Align] <String>] [[-ColumnSpan] <Int32>] [[-Description] <String>] [-DisableColumnMenu] [-DisableExport] [-DisableReorder] [-Editable] [[-Field] <String>] [-Filterable] [[-Flex] <Single>] [-Groupable] [[-HeaderAlign] <String>] [[-HeaderName] <String>] [-Hideable] [-HideSortIcons] [[-MaxWidth] <Int32>] [[-MinWidth] <Int32>] [-Pinnable] [-Resizable] [-Sortable] [[-SortingOrder] <String[]>] [[-Type] <String>] [[-Width] <Int32>] [[-Render] <ScriptBlock>] [[-ValueOptions] <String[]>] [-Hide] [<CommonParameters>]

Description

Creates a new data grid column.

Parameters

-CellClassName

CSS class name to be applied on cell element.

Required?                    false
Position?                    1
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Align

The alignment of the cell data. Possible values are 'left', 'center' and 'right'.

Required?                    false
Position?                    2
Default value                left
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-ColumnSpan

The number of columns that the column should span.

Required?                    false
Position?                    3
Default value                1
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Description

The description of the column that appears when hovering the header cell.

Required?                    false
Position?                    4
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

    -DisableColumnMenu [<SwitchParameter>]
        If true, the column menu is disabled.

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

    -DisableExport [<SwitchParameter>]
        If true, the column is not exported.

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

    -DisableReorder [<SwitchParameter>]
        If true, the column cannot be reordered.

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

    -Editable [<SwitchParameter>]
        If true, the column is editable.

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

-Field

The field of the row data that the column represents.

Required?                    false
Position?                    5
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

    -Filterable [<SwitchParameter>]
        If true, the column is filterable.

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

-Flex

The flex value used to set the column width.

Required?                    false
Position?                    6
Default value                1
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

    -Groupable [<SwitchParameter>]
        If true, the column is groupable.

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

-HeaderAlign

The alignment of the column header cell. Possible values are 'left', 'center' and 'right'.

Required?                    false
Position?                    7
Default value                left
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-HeaderName

The name of the column header.

Required?                    false
Position?                    8
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

    -Hideable [<SwitchParameter>]
        If true, the column is hideable.

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

    -HideSortIcons [<SwitchParameter>]
        If true, the sort icons are hidden.

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

-MaxWidth

The maximum width of the column.

Required?                    false
Position?                    9
Default value                0
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-MinWidth

The minimum width of the column.

Required?                    false
Position?                    10
Default value                0
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

    -Pinnable [<SwitchParameter>]
        If true, the column is pinnable.

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

    -Resizable [<SwitchParameter>]
        If true, the column is resizable.

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

    -Sortable [<SwitchParameter>]
        If true, the column is sortable.

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

-SortingOrder <String[]>

The sorting order of the column. Possible values are 'asc', 'desc' and null.

Required?                    false
Position?                    11
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Type

The type of the column. Possible values are 'string' | 'number' | 'date' | 'dateTime' | 'boolean' | 'singleSelect';

Required?                    false
Position?                    12
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Width

The width of the column.

Required?                    false
Position?                    13
Default value                0
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Render

A script block that is used to render the column. The script block is passed the row data as $EventData.

Required?                    false
Position?                    14
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-ValueOptions <String[]>

An array of options for the column filter when the filter is set to singleSelect.

Required?                    false
Position?                    15
Default value
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

    -Hide [<SwitchParameter>]

Required?                    false
Position?                    named
Default value                False
Accept pipeline input?       false
Aliases
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).