Set-RoyalSortOrder

Set-RoyalSortOrder

Scripting > Reference > PowerShell Commandlets >

NAME

Set-RoyalSortOrder
 
 

 

SYNOPSIS

This commandlet sorts a RoyalFolder by various parameters
 
 
 

 

SYNTAX

Set-RoyalSortOrder [-Folder] <RoyalFolder> [[-Criteria1] <RoyalObjectSortCriteria>] [[-Criteria2] <Nullable`1>]
[[-Criteria3] <Nullable`1>] [[-SortDirection1] <RoyalObjectSortDirection>] [[-SortDirection2]
<RoyalObjectSortDirection>] [[-SortDirection3] <RoyalObjectSortDirection>] [[-Recurse] <Nullable`1>]
[<CommonParameters>]
 
 
 

 

DESCRIPTION

This commandlet sorts a given RoyalFolder based on the provided sort criteria. Up to three levels of sorting
criterias are supported. Additionally the sorting can be specified to be applied recursively to the RoyalDocument.
 
 

 

PARAMETERS

-Folder <RoyalFolder>
The RoyalObject or RoyalFolder thas is going to be sorted.
 
Required? true
Position? 0
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
-Criteria1 <RoyalObjectSortCriteria>
The first sorting criteria.
 
Required? false
Position? 1
Default value None
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
-Criteria2 <Nullable`1>
The second sorting criteria.
 
Required? false
Position? 2
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
-Criteria3 <Nullable`1>
The third sorting criteria.
 
Required? false
Position? 3
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
-SortDirection1 <RoyalObjectSortDirection>
The first sort direction criteria.
 
Required? false
Position? 4
Default value 0
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
-SortDirection2 <RoyalObjectSortDirection>
The second sort direction criteria.
 
Required? false
Position? 5
Default value 0
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
-SortDirection3 <RoyalObjectSortDirection>
The third sort direction criteria.
 
Required? false
Position? 6
Default value 0
Accept pipeline input? true (ByValue, ByPropertyName)
Accept wildcard characters? false
 
-Recurse <Nullable`1>
Defines if the sorting should be applied recursively.
 
Required? false
Position? 7
Default value
Accept pipeline input? true (ByValue, ByPropertyName)
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).
 
 

 

INPUTS

RoyalDocumentLibrary.RoyalFolder
The RoyalObject or RoyalFolder thas is going to be sorted.
 
RoyalDocument.PowerShell.RoyalObjectSortCriteria
The first sorting criteria.
 
System.Nullable`1[[RoyalDocument.PowerShell.RoyalObjectSortCriteria, RoyalDocument.PowerShell, Version=1.0.0.0,
Culture=neutral, PublicKeyToken=null]]
The second sorting criteria.
 
RoyalDocument.PowerShell.RoyalObjectSortDirection
The first sort direction criteria.
 
System.Nullable`1[[System.Boolean, mscorlib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089]]
Defines if the sorting should be applied recursively.
 
 
 

 

OUTPUTS

 
---------- EXAMPLE 1 ----------
 
Set-RoyalSortOrder -Criteria1 Name -SortDirection1 Ascending -Folder $doc
 
This cmdlet returns the provided Folder sorted by the provided sort criteria.
 
 

 

RELATED LINKS

New-RoyalObject

Move-RoyalObject

Copy-RoyalObject

Set-RoyalObjectValue

Get-RoyalObjectValue

Get-RoyalObject