Click or drag to resize

SortAndGroup Class
Command used by BatchMacro to sort and group a list of files, directory content or documents according to specified patterns and order.
Inheritance Hierarchy
SystemObject
  MediaCy.IQL.ApplicationMcCommand
    MediaCy.IQL.ApplicationMcCommandExtended
      MediaCy.CommandsBaseCommand
        MediaCy.CommandsOneInputOneOutputCommandIList, IList
          MediaCy.Addins.ScriptingSortAndGroup

Namespace:  MediaCy.Addins.Scripting
Assembly:  MediaCy.Addins.Scripting (in MediaCy.Addins.Scripting.dll) Version: 3.1.0.0
Syntax
VB
Copy
Public Class SortAndGroup
	Inherits OneInputOneOutputCommand(Of IList, IList)
	Implements IComparer, IComparer(Of String), 
	IComparer(Of KeyValuePair(Of String, Object))

The SortAndGroup type exposes the following members.

Constructors
  NameDescription
Public methodSortAndGroup
Initializes a new instance of the SortAndGroup class
Top
Properties
  NameDescription
Public propertyDocumentFormats
A semi colon separated list of the document formats to process designated by their extension.
Public propertyGroupPattern
Identifies the part of the filenames that will be used for grouping. When non empty, it defines the pattern used to identify each group according to the regex syntax as implemented by Microsoft. See http://msdn.microsoft.com/en-us/library/az24scfc.aspx. The part of the name is identified by a regex group, for example "(\d+)" would produce the groups: (AnImgDapi001.tif, AnImgFitc001.tif), (AnImgDapi002.tif, AnImgFitc002.tif) . The single number special case defines the number of objects to put in each group.
Public propertyGroupSortingOrder
Defines the type of group sorting.
Public propertyProcessSubfolders
Whether or not to process subfolders.
Public propertySortingOrder
Defines the type of global sorting.
Public propertySortPattern
Identifies the part of the filenames that will be used for sorting. If this property is empty, then the full name is used for sorting, otherwise the syntax is the regex syntax as implemented by Microsoft. See http://msdn.microsoft.com/en-us/library/az24scfc.aspx. The part of the name is identified by a regex group, for example "(\d+)" would identify the numeric end of the following strings: AnImgDapi001.tif, AnImgFitc001.tif, AnImgDapi002.tif, AnImgFitc002.tif .
Top
Methods
Remarks
The input is a list of object which can contain the paths of files and directories as well as documents. Directories are expanded to file lists according to the specified extensions and recursivity options. The output is either a sorted list of individual files and documents, or a list of lists when grouping is performed.
See Also