New-UDTableColumn

Synopsis

Defines a table column.

Syntax

New-UDTableColumn [[-Id] <String>] [-Property] <String> [[-Title] <String>] [[-OnRender] <ScriptBlock>] [-ShowSort] [-ShowFilter] [[-FilterType] <String>] [[-Style] <Hashtable>] [[-Width] <Int32>] [[-MinWidth] <Int32>] [-IncludeInSearch] [-IncludeInExport] [-DefaultSortColumn] [[-Align] <String>] [-Truncate] [[-SortType] <String>] [-Hidden] [[-Options] <String[]>] [[-Header] <ScriptBlock>] [<CommonParameters>]

Description

Defines a table column. Use this cmdlet in conjunction with New-UDTable's -Column property. Table columns can be used to control many aspects of the columns within a table.

Parameters

-Id

The ID of the component. It defaults to a random GUID.

Required?                    false
Position?                    1
Default value                [Guid]::NewGuid().ToString()
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Property

The property to select from the data.

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

-Title

The title of the column to show at the top of the table.

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

-OnRender

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

-ShowSort

Whether this column supports sorting.

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

-ShowFilter

Whether this column supports filtering.

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

-FilterType

The type of filter to use with this column. Valid values are "text", "select", "fuzzy", "slider", "range", "date", "number", 'autocomplete', 'multiselect'

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

-Style

A hashtable of style attributes to apply to the column.

Required?                    false
Position?                    6
Default value                @{ }
Accept pipeline input?       false
Aliases
Accept wildcard characters?  false

-Width

The width of this column in pixels.

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

-MinWidth

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

-IncludeInSearch

Whether to include this column in the search.

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

-IncludeInExport

Whether to include this column in the export.

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

-DefaultSortColumn

Sets this column as the default sort column.

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

-Align

The alignment of the column. Supported values are 'center', 'inherit', 'justify', 'left', 'right'.

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

-Truncate

Whether to truncate the text in this column. A -Width is required to use truncate.

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

-SortType

Whether to sort this column as a string or datetime.

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

-Hidden

Includes a column in the table but does not show it. This is useful for columns that are used for filtering and exporting but are not meant to be displayed in the table.

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

-Options <String[]>

The options to use for a select filter.

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

-Header

Script block that renders custom header content for this column instead of the default table header. Its output is assigned to the column's customHeader property.

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

Common parameters

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

Outputs

Examples

Example 1

See New-UDTable for examples.